joommf项目的元包。
joommf的Python项目详细描述
joommf
Marijan Beg1,2、Ryan A.Pepper2、Thomas Kluyver1和Hans Fangohr1,2
1欧洲xfel股份有限公司，Holzkoppel 422869 Schenefeld，德国
联合王国南安普敦大学工程与环境学院
| Description | Badge |
|---|---|
| Latest release | |
| Build | |
| Coverage | |
| Documentation | |
| Binder | |
| Dependecies | |
| License |
依赖关系概述
| joommfutil | discretisedfield | oommfodt | micromagneticmodel | oommfc | |
|---|---|---|---|---|---|
| Latest release | |||||
| Build | |||||
| Coverage | |||||
| Documentation | |||||
| Binder | |||||
| Dependecies | |||||
| License |
关于
joommf是一个python包，它是jupyter oommf（joommf）项目的元包，用于简单安装运行joommf所需的所有包。
它适用于所有主要操作系统（windows、macos、linux），并且需要python 3.5或更高版本。
安装
我们建议使用pip或conda包管理器安装joommf。
python需求
在通过pip安装joommf之前，请确保系统中有python 3.5或更高版本。您可以通过运行
python3 --version
如果您在linux上，很可能已经安装了python。然而，在macos和windows上，通常情况并非如此。如果您的计算机上没有python 3.5或更高版本，强烈建议安装Anacondapython发行版。Download Anaconda对于您的操作系统，请按照下载页上的说明进行操作。有关安装Python的更多信息，请参见here。
oommf要求
joommf是一个用于驱动OOMMF的python包。因此，oommf是joommf的一个需求（依赖项）。如果您决定使用conda安装joommf，则会自动安装oommf。但是，如果您决定使用pip进行joommf安装，我们强烈建议使用conda安装oommf。您可以通过运行以下命令安装oommf：
conda install --channel conda-forge oommf
注意：有关如何安装anaconda python发行版的详细信息，请参见conda部分。
pip
在macos或windows上安装anaconda之后，还将安装pip。但是，在linux上，如果您还没有pip，可以使用
sudo apt install python3-pip
要在所有操作系统上安装当前位于python包索引存储库中的joommf版本，请运行：
python3 -m pip install joommf
conda
joommf通过运行conda安装
conda install --channel conda-forge joommf
有关conda包、依赖项和环境管理的更多信息，请查看其documentation。
更新
如果使用pip安装joommf，则可以通过运行PyPI更新到最新发布的版本
python3 -m pip install --upgrade joommf
另一方面，如果使用conda进行安装，请使用
joommfconda upgrade joommf
开发版本
尚未发布的joommf的最新开发版本可以使用
git clone https://github.com/joommf/joommf
python3 -m pip install --upgrade joommf
注意：如果系统上没有git，则可以按照说明here安装。
活页夹
joommf可以通过活页夹在云中使用。这不要求您安装任何内容，并且不会在您的计算机上创建任何文件。要在云中使用joommf，请遵循以下步骤link。
文档
提供了joommf的文档here，其中提供了api和教程（以jupyter笔记本的形式）。
支架
如果您需要安装或使用joommf的支持，或者想要报告问题，欢迎您在我们的joommf/help存储库中提出问题。
许可证
根据BSD第3条“新”或“修订”许可进行许可。有关详细信息，请参阅LICENSE文件。
如何引用
如果你在研究中使用joommf，请引用为：
M.Beg，R.A.Pepper和H.Fangohr。计算科学用户界面：一种嵌入在python中的面向对象的特定领域语言。AIP Advances, 7, 56025（2017年）。
<李>
DOI将很快提供
致谢
joommf是{a14}–地平线2020欧洲研究基础设施项目（676541）的一部分。
欢迎加入QQ群-->： 979659372
