{
"info": {
"author": "Marijan Beg, Ryan A. Pepper, Thomas Kluyver, and Hans Fangohr",
"author_email": "jupyteroommf@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: BSD License",
"Natural Language :: English",
"Operating System :: MacOS",
"Operating System :: Microsoft :: Windows",
"Operating System :: Unix",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Scientific/Engineering :: Physics"
],
"description": "# joommf\nMarijan Beg1,2, Ryan A. Pepper2, Thomas Kluyver1, and Hans Fangohr1,2\n\n1 *European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany* \n2 *Faculty of Engineering and the Environment, University of Southampton, Southampton SO17 1BJ, United Kingdom* \n\n| Description | Badge |\n| --- | --- |\n| Latest release | [](https://badge.fury.io/py/joommf) |\n| | [](https://anaconda.org/conda-forge/joommf) |\n| Build | [](https://travis-ci.org/joommf/joommf) |\n| | [](https://ci.appveyor.com/project/marijanbeg/joommf) |\n| Coverage | [](https://codecov.io/gh/joommf/joommf) |\n| Documentation | [](http://joommf.readthedocs.io/en/latest/?badge=latest) |\n| Binder | [](https://mybinder.org/v2/gh/joommf/joommf/master?filepath=index.ipynb) |\n| Dependecies | [](https://requires.io/github/joommf/joommf/requirements/?branch=master) |\n| License | [](https://opensource.org/licenses/BSD-3-Clause) |\n\n# Dependencies overview\n\n| | joommfutil | discretisedfield | oommfodt | micromagneticmodel | oommfc |\n| --- | --- | --- | --- | --- | --- |\n| Latest release | [](https://badge.fury.io/py/joommfutil) | [](https://badge.fury.io/py/discretisedfield) | [](https://badge.fury.io/py/oommfodt) | [](https://badge.fury.io/py/micromagneticmodel) | [](https://badge.fury.io/py/oommfc) |\n| | [](https://anaconda.org/conda-forge/joommfutil) | [](https://anaconda.org/conda-forge/discretisedfield) | [](https://anaconda.org/conda-forge/oommfodt) | [](https://anaconda.org/conda-forge/micromagneticmodel) | [](https://anaconda.org/conda-forge/oommfc) |\n| Build | [](https://travis-ci.org/joommf/joommfutil) | [](https://travis-ci.org/joommf/discretisedfield) | [](https://travis-ci.org/joommf/oommfodt) | [](https://travis-ci.org/joommf/micromagneticmodel) | [](https://travis-ci.org/joommf/oommfc) |\n| | [](https://ci.appveyor.com/project/marijanbeg/joommfutil) | [](https://ci.appveyor.com/project/marijanbeg/discretisedfield/branch/master) | [](https://ci.appveyor.com/project/marijanbeg/oommfodt) | [](https://ci.appveyor.com/project/marijanbeg/micromagneticmodel) | [](https://ci.appveyor.com/project/marijanbeg/oommfc) |\n| Coverage | [](https://codecov.io/gh/joommf/joommfutil) | [](https://codecov.io/gh/joommf/discretisedfield) | [](https://codecov.io/gh/joommf/oommfodt) | [](https://codecov.io/gh/joommf/micromagneticmodel) | [](https://codecov.io/gh/joommf/oommfc) |\n| Documentation | [](http://joommfutil.readthedocs.io/en/latest/?badge=latest) | [](http://discretisedfield.readthedocs.io/en/latest/?badge=latest) | [](http://oommfodt.readthedocs.io/en/latest/?badge=latest) | [](http://micromagneticmodel.readthedocs.io/en/latest/?badge=latest) | [](http://oommfc.readthedocs.io/en/latest/?badge=latest) |\n| Binder | [](https://mybinder.org/v2/gh/joommf/joommfutil/master?filepath=index.ipynb) | [](https://mybinder.org/v2/gh/joommf/discretisedfield/master?filepath=index.ipynb) | [](https://mybinder.org/v2/gh/joommf/oommfodt/master?filepath=index.ipynb) | [](https://mybinder.org/v2/gh/joommf/micromagneticmodel/master?filepath=index.ipynb) | [](https://mybinder.org/v2/gh/joommf/oommfc/master?filepath=index.ipynb) |\n| Dependecies | [](https://requires.io/github/joommf/joommfutil/requirements/?branch=master) | [](https://requires.io/github/joommf/discretisedfield/requirements/?branch=master) | [](https://requires.io/github/joommf/oommfodt/requirements/?branch=master) | [](https://requires.io/github/joommf/micromagneticmodel/requirements/?branch=master) | [](https://requires.io/github/joommf/oommfc/requirements/?branch=master) |\n| License | [](https://opensource.org/licenses/BSD-3-Clause) | [](https://opensource.org/licenses/BSD-3-Clause) | [](https://opensource.org/licenses/BSD-3-Clause) | [](https://opensource.org/licenses/BSD-3-Clause) | [](https://opensource.org/licenses/BSD-3-Clause) |\n\n## About\n\n`joommf` is a Python package that is a meta package for Jupyter-OOMMF (JOOMMF) project intended for simple installation of all packages required to run JOOMMF.\n\nIt is available on all major operating systems (Windows, MacOS, Linux) and requires Python 3.5 or higher.\n\n## Installation\n\nWe recommend installing `joommf` by using either of the `pip` or `conda` package managers.\n\n#### Python requirements\n\nBefore installing `joommf` via `pip`, please make sure you have Python 3.5 or higher on your system. You can check that by running\n\n python3 --version\n\nIf you are on Linux, it is likely that you already have Python installed. However, on MacOS and Windows, this is usually not the case. If you do not have Python 3.5 or higher on your machine, we strongly recommend installing the [Anaconda](https://www.anaconda.com/) Python distribution. [Download Anaconda](https://www.anaconda.com/download) for your operating system and follow instructions on the download page. Further information about installing Anaconda can be found [here](https://conda.io/docs/user-guide/install/download.html).\n\n#### OOMMF requirements\n\n`joommf` is a Python package used to drive [OOMMF](https://math.nist.gov/oommf/). Therefore, OOMMF is a requirement (dependency) of `joommf`. If you decide to install `joommf` using `conda`, then OOMMF will be automatically installed. However, if you decide to use `pip` for `joommf` installation, we strongly recommend using conda to install OOMMF. You can install OOMMF by running:\n\n conda install --channel conda-forge oommf\n\n**Note:** Details on how to install Anaconda Python distribution can be found in the `conda` section.\n\n#### `pip`\n\nAfter installing Anaconda on MacOS or Windows, `pip` will also be installed. However, on Linux, if you do not already have `pip`, you can install it with\n\n sudo apt install python3-pip\n\nTo install the `joommf` version currently in the Python Package Index repository [PyPI](https://pypi.org/project/joommf/) on all operating systems run:\n\n python3 -m pip install joommf\n\n#### `conda`\n\n`joommf` is installed using `conda` by running\n\n conda install --channel conda-forge joommf\n\nFor further information on the `conda` package, dependency, and environment management, please have a look at its [documentation](https://conda.io/docs/). \n\n## Updating\n\nIf you used pip to install `joommf`, you can update to the latest released version in [PyPI](https://pypi.org/project/joommf/) by running\n\n python3 -m pip install --upgrade joommf\n\nOn the other hand, if you used `conda` for installation, update `joommf` with\n\n conda upgrade joommf\n\n#### Development version\n\nThe most recent development version of `joommf` that is not yet released can be installed/updated with\n\n git clone https://github.com/joommf/joommf\n python3 -m pip install --upgrade joommf\n\n**Note**: If you do not have `git` on your system, it can be installed by following the instructions [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).\n\n## Binder\n\n`joommf` can be used in the cloud via Binder. This does not require you to have anything installed and no files will be created on your machine. To use `joommf` in the cloud, follow this [link](https://mybinder.org/v2/gh/joommf/joommf/master?filepath=index.ipynb).\n\n## Documentation\n\nDocumentation for `joommf` is available [here](http://joommf.readthedocs.io/en/latest/?badge=latest), where APIs and tutorials (in the form of Jupyter notebooks) are available.\n\n## Support\n\nIf you require support on installation or usage of `joommf` or if you want to report a problem, you are welcome to raise an issue in our [joommf/help](https://github.com/joommf/help) repository.\n\n## License\n\nLicensed under the BSD 3-Clause \"New\" or \"Revised\" License. For details, please refer to the [LICENSE](LICENSE) file.\n\n## How to cite\n\nIf you use `joommf` in your research, please cite it as:\n\n1. M. Beg, R. A. Pepper, and H. Fangohr. User interfaces for computational science: A domain specific language for OOMMF embedded in Python. [AIP Advances, 7, 56025](http://aip.scitation.org/doi/10.1063/1.4977225) (2017).\n\n2. DOI will be available soon\n\n## Acknowledgements\n\n`joommf` was developed as a part of [OpenDreamKit](http://opendreamkit.org/) \u2013 Horizon 2020 European Research Infrastructure project (676541).\n\n\n",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://joommf.github.io",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "joommf",
"package_url": "https://pypi.org/project/joommf/",
"platform": "",
"project_url": "https://pypi.org/project/joommf/",
"project_urls": {
"Homepage": "https://joommf.github.io"
},
"release_url": "https://pypi.org/project/joommf/0.8.4/",
"requires_dist": [
"oommfc",
"jupyter"
],
"requires_python": "",
"summary": "Meta package for JOOMMF project.",
"version": "0.8.4"
},
"last_serial": 4044903,
"releases": {
"0.1": [
{
"comment_text": "",
"digests": {
"md5": "e349b82e62bb3901c40d7f4e4fe6a13c",
"sha256": "27523b287c0b4f43af0f2c54a891ca8a2fe83ccfb28ce295c9ff8502ef8f42a9"
},
"downloads": -1,
"filename": "joommf-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e349b82e62bb3901c40d7f4e4fe6a13c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2333,
"upload_time": "2017-09-26T09:29:41",
"url": "https://files.pythonhosted.org/packages/cd/03/73f4076d1c57521453136d1f083e1dc75232e1813d154bd5a68e725f59da/joommf-0.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "cfc403a190d84878baf1196fedde93da",
"sha256": "4b1ba19cc8fc8794a56a10cb794205544f9cace6260b87df256ffe4a061b621b"
},
"downloads": -1,
"filename": "joommf-0.1.tar.gz",
"has_sig": false,
"md5_digest": "cfc403a190d84878baf1196fedde93da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1167,
"upload_time": "2017-09-26T09:29:44",
"url": "https://files.pythonhosted.org/packages/89/f1/b13f5989339b48c1c4e46ed80d5444712710a694fc690bfab89658b81e1d/joommf-0.1.tar.gz"
}
],
"0.2": [
{
"comment_text": "",
"digests": {
"md5": "1572d913469fdd6679c5d00c25fc6ff4",
"sha256": "48180cec46ec031cb6019b6ccee514c2e2e9e0feb12b55a0911ed0758061abcd"
},
"downloads": -1,
"filename": "joommf-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1572d913469fdd6679c5d00c25fc6ff4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2343,
"upload_time": "2017-09-26T09:46:21",
"url": "https://files.pythonhosted.org/packages/98/e4/242ee908c99fd5270fa7f3ca04bab63a9097495ec0e97886d3afc4ffc2f4/joommf-0.2-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "1f074d850300b13c1bbd9bdd106980dd",
"sha256": "0b557bb24c0fb238f55656360b193a370f3700b67f514489dccc95caeee75b79"
},
"downloads": -1,
"filename": "joommf-0.2.tar.gz",
"has_sig": false,
"md5_digest": "1f074d850300b13c1bbd9bdd106980dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1173,
"upload_time": "2017-09-26T09:46:22",
"url": "https://files.pythonhosted.org/packages/bb/13/a00a0faef4f1b71d236ae808ba1aae9af3122e74aacdf203436c25aebcfa/joommf-0.2.tar.gz"
}
],
"0.8": [
{
"comment_text": "",
"digests": {
"md5": "f26e07640be7f23f918832e92c7a0593",
"sha256": "1ce92d768daa5c5c90b4c31ff9f3f0b0d8cfb8e9001d66926c54b9209b7885d4"
},
"downloads": -1,
"filename": "joommf-0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f26e07640be7f23f918832e92c7a0593",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4334,
"upload_time": "2018-07-01T13:13:29",
"url": "https://files.pythonhosted.org/packages/95/38/babc986019bcbeb0f386d0c0b49236df2a0ec6510579b2496e19244c7972/joommf-0.8-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "b443f97530f4290bb09d3cbfec5dbf41",
"sha256": "b2a4b1fce0377318b47bc1dee1d2a5f36b32d22136716cc1dbfe5d437062912b"
},
"downloads": -1,
"filename": "joommf-0.8.tar.gz",
"has_sig": false,
"md5_digest": "b443f97530f4290bb09d3cbfec5dbf41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5469,
"upload_time": "2018-07-01T13:13:30",
"url": "https://files.pythonhosted.org/packages/cd/59/a155537f84d5f7ff7cb84fbd36fa6d9bbbd1605ef0eaef8a7144fbea2d08/joommf-0.8.tar.gz"
}
],
"0.8.1": [
{
"comment_text": "",
"digests": {
"md5": "29888c66c2d2df860b1796ded68bc1b8",
"sha256": "69c9bc12248f16f7c0c6f213c2bc9e60972b24bb06462cd12a950995e107d26c"
},
"downloads": -1,
"filename": "joommf-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29888c66c2d2df860b1796ded68bc1b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4860,
"upload_time": "2018-07-01T15:46:20",
"url": "https://files.pythonhosted.org/packages/ce/e7/d96711290fc9c7cca15653ee1c1c333f9009c8dceda30ea8829f647f38d7/joommf-0.8.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "43cd797b5a0bb8b469f0656592df0ba0",
"sha256": "ea31be8b08fa9f3f545b2790b7c9f1268ee9a95aeb3ee1f443ff8a532799f912"
},
"downloads": -1,
"filename": "joommf-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "43cd797b5a0bb8b469f0656592df0ba0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5643,
"upload_time": "2018-07-01T15:46:21",
"url": "https://files.pythonhosted.org/packages/95/cb/6ace71a5330196927ec7a29007eb4fc975acf9ba6cbb5a68f3ee34b02339/joommf-0.8.1.tar.gz"
}
],
"0.8.2": [
{
"comment_text": "",
"digests": {
"md5": "e692170e360aa151f60b6c6b56cdcb82",
"sha256": "a9ad61c4548e39df218ab97bdaa1f6bc6521a4a4da6061c6eb9aea171287d7e8"
},
"downloads": -1,
"filename": "joommf-0.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e692170e360aa151f60b6c6b56cdcb82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4859,
"upload_time": "2018-07-01T15:48:38",
"url": "https://files.pythonhosted.org/packages/a6/e5/833755c593b8128b2d71c54048c2df08e3938412bbb86a1dcee73f9f237f/joommf-0.8.2-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "c54741afe5eb40fc68aa62a793e800c8",
"sha256": "0ba319e69ae9cc96537745dd19fa19d124f7abc24193b9a0e02ca8dd211e5f99"
},
"downloads": -1,
"filename": "joommf-0.8.2.tar.gz",
"has_sig": false,
"md5_digest": "c54741afe5eb40fc68aa62a793e800c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5640,
"upload_time": "2018-07-01T15:48:40",
"url": "https://files.pythonhosted.org/packages/b3/c7/de6a93de8c0d8fbe9d96f4cad3990fc49c0665368823df17578348cd076a/joommf-0.8.2.tar.gz"
}
],
"0.8.3": [
{
"comment_text": "",
"digests": {
"md5": "9e56f81b93ed5442d5ea9c671af6c921",
"sha256": "6f2dc0cdd922fec14a35cbb5bf1aa39fd6109854153655fc0fb10832775c10db"
},
"downloads": -1,
"filename": "joommf-0.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e56f81b93ed5442d5ea9c671af6c921",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4863,
"upload_time": "2018-07-01T16:48:54",
"url": "https://files.pythonhosted.org/packages/73/47/3cb989ffe9365e7a3abc63d3d84c9e292fa782e5a5ba84e3050deecccaa7/joommf-0.8.3-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "69ab816a8717e35f4aa10c09df1843a3",
"sha256": "d1f31753d829d172b68a8720416f0e413c741b34b69235a8e324056db3264cf9"
},
"downloads": -1,
"filename": "joommf-0.8.3.tar.gz",
"has_sig": false,
"md5_digest": "69ab816a8717e35f4aa10c09df1843a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5648,
"upload_time": "2018-07-01T16:48:56",
"url": "https://files.pythonhosted.org/packages/b5/5b/d2b8404f64e27d52a002a9f070665734c382fbf5b05e1457a3ad605914c6/joommf-0.8.3.tar.gz"
}
],
"0.8.4": [
{
"comment_text": "",
"digests": {
"md5": "cfc4b9fdc53ed7878b1ebf856343b73a",
"sha256": "1f7b6d9664c7747c7b88bc8256aada8f9e044712224f3ea03f26f76db1c61bf0"
},
"downloads": -1,
"filename": "joommf-0.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfc4b9fdc53ed7878b1ebf856343b73a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4920,
"upload_time": "2018-07-09T19:55:59",
"url": "https://files.pythonhosted.org/packages/08/1d/f9a70ed2a1c0dc29daffec228d7aaf6c34d7793472c8e52f2db72978fe67/joommf-0.8.4-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "155099acf9369e702d49561cdc087b9e",
"sha256": "58b9f18768b2d4a9d51a17803f523ce94c11cc64dc7090b75a2cf37a5f91240d"
},
"downloads": -1,
"filename": "joommf-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "155099acf9369e702d49561cdc087b9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5737,
"upload_time": "2018-07-09T19:56:00",
"url": "https://files.pythonhosted.org/packages/f4/ca/a65aa32ec858b198dcfbf388ae61a7ad4f27118d113398ed3576c652d8cc/joommf-0.8.4.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "cfc4b9fdc53ed7878b1ebf856343b73a",
"sha256": "1f7b6d9664c7747c7b88bc8256aada8f9e044712224f3ea03f26f76db1c61bf0"
},
"downloads": -1,
"filename": "joommf-0.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfc4b9fdc53ed7878b1ebf856343b73a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4920,
"upload_time": "2018-07-09T19:55:59",
"url": "https://files.pythonhosted.org/packages/08/1d/f9a70ed2a1c0dc29daffec228d7aaf6c34d7793472c8e52f2db72978fe67/joommf-0.8.4-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "155099acf9369e702d49561cdc087b9e",
"sha256": "58b9f18768b2d4a9d51a17803f523ce94c11cc64dc7090b75a2cf37a5f91240d"
},
"downloads": -1,
"filename": "joommf-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "155099acf9369e702d49561cdc087b9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5737,
"upload_time": "2018-07-09T19:56:00",
"url": "https://files.pythonhosted.org/packages/f4/ca/a65aa32ec858b198dcfbf388ae61a7ad4f27118d113398ed3576c652d8cc/joommf-0.8.4.tar.gz"
}
]
}