cfsem

文档 - Rust | 文档 - Python

包括丝状近似、Biot-Savart和Grad-Shafranov的准静态电磁学。

为了避免重复，大多数测试和示例应用程序可以在Python绑定中找到。

该库使用了FMA（融合乘加）指令；因此，启用针对x86目标的+fma标志会显著提高其性能。请参阅此项目的rustc配置以获取启用x86目标的FMA的示例配置。aarch64目标（如Apple和Raspberry Pi处理器）默认启用FMA。

安装

要将此库包含到Rust项目中，请向Cargo.toml的[dependencies]部分添加一个条目

cfsem = "*"

有关Python安装的详细信息，请参阅Python库的文档。

基准测试

基准测试配置在Cargo.toml中，可以通过cargo运行

cargo bench

贡献

欢迎符合包目标和反目标的贡献。

请在投入大量时间到分支之前提出问题票以讨论更改。

目标

• 库级函数和公式
• 全面的文档，包括文献参考、假设和单位
• 公式的定量单元测试
• 性能（速度和内存效率）
  • 通过结构化基准测试指导性能敏感函数的开发
• 跨平台兼容性
• 最小化长期维护开销（对于库及其用户）
  • 语义版本控制
  • 自动linting和格式化工具
  • 在尽可能少的文件中集中CI和工具链配置

反目标

• 增加环境复杂性、模糊推理或引入平台限制的花哨功能
• 脆弱的CI或工具链过程，导致维护开销增加
• 应用程序级功能（图形界面、仿真框架等）

许可证

根据以下之一许可

• Apache License，版本2.0，(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• 麻省理工学院许可证（《LICENSE-MIT》或http://opensource.org/licenses/MIT）

根据您的选择。