| Name | chaosmagpy JSON |
| Version |
0.15
JSON |
| download |
| home_page | None |
| Summary | Evaluates the CHAOS geomagnetic field model and other models of Earth's magnetic field. |
| upload_time | 2025-07-18 11:27:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license |
License
=======
All ChaosMagPy source code and documentation is Copyright (C) Clemens Kloss
and, unless explicitly stated, licensed under the MIT license.
The exception is with regard to some of the stand-alone example scripts in the
ChaosMagPy documentation gallery, which are licensed under the GNU Lesser
General Public License as published by the Free Software Foundation, either
version 3 of the License, or (at your option) any later version. This is
explicitly stated in the header of these example scripts.
MIT License
-----------
Copyright (C) 2025 Clemens Kloss.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
chaos
geomagnetic field
spherical harmonics model
secular variation
core field
crustal field
magnetospheric field
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
scipy
pandas
Cython
h5py
pyshp
matplotlib
hdf5storage
lxml
apexpy
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Overview
========
ChaosMagPy is a simple Python package for evaluating the CHAOS geomagnetic
field model and other models of Earth's magnetic field. The latest CHAOS model
is available at http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/.
Documentation
-------------
The documentation of the current release is available on Read the Docs
(https://chaosmagpy.readthedocs.io/en/)
|pypi| |docs| |doi| |license|
.. |pypi| image:: https://badge.fury.io/py/chaosmagpy.svg
:target: https://badge.fury.io/py/chaosmagpy/
.. |docs| image:: https://readthedocs.org/projects/chaosmagpy/badge/
:target: https://chaosmagpy.readthedocs.io/en/
:alt: Documentation Status
.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: license.html
.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3352398.svg
:target: https://doi.org/10.5281/zenodo.3352398
Citation
--------
To reference ChaosMagPy in publications, please cite the package itself
https://doi.org/10.5281/zenodo.3352398
and, for CHAOS-7, the relevant journal publication:
Finlay, C.C., Kloss, C., Olsen, N., Hammer, M. Toeffner-Clausen, L.,
Grayver, A and Kuvshinov, A. (2020), The CHAOS-7 geomagnetic field model and
observed changes in the South Atlantic Anomaly, Earth Planets and Space 72,
doi:10.1186/s40623-020-01252-9
or, for the earlier CHAOS models, some of the following:
Finlay, C.C., Olsen, N., Kotsiaros, S., Gillet, N. and Toeffner-Clausen, L. (2016),
Recent geomagnetic secular variation from Swarm and ground observatories
as estimated in the CHAOS-6 geomagnetic field model Earth Planets Space,
Vol 68, 112. doi: 10.1186/s40623-016-0486-1
Olsen, N., Luehr, H., Finlay, C.C., Sabaka, T. J., Michaelis, I., Rauberg, J. and Toeffner-Clausen, L. (2014),
The CHAOS-4 geomagnetic field model, Geophys. J. Int., Vol 197, 815-827,
doi: 10.1093/gji/ggu033.
Olsen, N., Luehr, H., Sabaka, T.J., Mandea, M. ,Rother, M., Toeffner-Clausen, L. and Choi, S. (2006),
CHAOS — a model of Earth's magnetic field derived from CHAMP, Ørsted, and SAC-C magnetic satellite data,
Geophys. J. Int., vol. 166 67-75
Installation
============
ChaosMagPy relies on the following (some are optional):
* python>=3.6
* numpy (>=2 if python>=3.12)
* scipy
* pandas
* cython
* h5py
* hdf5storage (>=0.2 if python>=3.12)
* pyshp>=2.3.1
* apexpy>=2.1.0 (optional, used for evaluating the ionospheric E-layer field)
* matplotlib>=3.6 (optional, used for plotting)
* lxml (optional, used for downloading latest RC-index file)
Specific installation steps for all dependencies, including optional packages,
using the conda/pip package managers are as follows:
1. Install packages with conda:
>>> conda install python numpy scipy pandas cython pyshp h5py matplotlib lxml
2. Install remaining packages with pip:
>>> pip install hdf5storage apexpy
3. Finally, install ChaosMagPy with pip:
>>> pip install chaosmagpy
Alternatively, if you have downloaded the distribution archives from the
Python Package Index (PyPI) at https://pypi.org/project/chaosmagpy/#files,
install ChaosMagPy using the built or source distributions:
>>> pip install chaosmagpy-x.x-py3-none-any.whl
or
>>> pip install chaosmagpy-x.x.tar.gz
replacing ``x.x`` with the relevant version.
Raw data
{
"_id": null,
"home_page": null,
"name": "chaosmagpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Clemens Kloss <ancklo@space.dtu.dk>",
"keywords": "CHAOS, geomagnetic field, spherical harmonics model, secular variation, core field, crustal field, magnetospheric field",
"author": null,
"author_email": "Clemens Kloss <ancklo@space.dtu.dk>",
"download_url": "https://files.pythonhosted.org/packages/b3/8a/353a5a89df6fd8315fb2694baee81fb7bb5affe7e0dc8f20ef538354baf2/chaosmagpy-0.15.tar.gz",
"platform": null,
"description": "\nOverview\n========\n\nChaosMagPy is a simple Python package for evaluating the CHAOS geomagnetic\nfield model and other models of Earth's magnetic field. The latest CHAOS model\nis available at http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/.\n\nDocumentation\n-------------\n\nThe documentation of the current release is available on Read the Docs\n(https://chaosmagpy.readthedocs.io/en/)\n\n|pypi| |docs| |doi| |license|\n\n.. |pypi| image:: https://badge.fury.io/py/chaosmagpy.svg\n :target: https://badge.fury.io/py/chaosmagpy/\n\n.. |docs| image:: https://readthedocs.org/projects/chaosmagpy/badge/\n :target: https://chaosmagpy.readthedocs.io/en/\n :alt: Documentation Status\n\n.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg\n :target: license.html\n\n.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3352398.svg\n :target: https://doi.org/10.5281/zenodo.3352398\n\nCitation\n--------\n\nTo reference ChaosMagPy in publications, please cite the package itself\n\nhttps://doi.org/10.5281/zenodo.3352398\n\nand, for CHAOS-7, the relevant journal publication:\n\nFinlay, C.C., Kloss, C., Olsen, N., Hammer, M. Toeffner-Clausen, L.,\nGrayver, A and Kuvshinov, A. (2020), The CHAOS-7 geomagnetic field model and\nobserved changes in the South Atlantic Anomaly, Earth Planets and Space 72,\ndoi:10.1186/s40623-020-01252-9\n\nor, for the earlier CHAOS models, some of the following:\n\nFinlay, C.C., Olsen, N., Kotsiaros, S., Gillet, N. and Toeffner-Clausen, L. (2016),\nRecent geomagnetic secular variation from Swarm and ground observatories\nas estimated in the CHAOS-6 geomagnetic field model Earth Planets Space,\nVol 68, 112. doi: 10.1186/s40623-016-0486-1\n\nOlsen, N., Luehr, H., Finlay, C.C., Sabaka, T. J., Michaelis, I., Rauberg, J. and Toeffner-Clausen, L. (2014),\nThe CHAOS-4 geomagnetic field model, Geophys. J. Int., Vol 197, 815-827,\ndoi: 10.1093/gji/ggu033.\n\nOlsen, N., Luehr, H., Sabaka, T.J., Mandea, M. ,Rother, M., Toeffner-Clausen, L. and Choi, S. (2006),\nCHAOS \u2014 a model of Earth's magnetic field derived from CHAMP, \u00d8rsted, and SAC-C magnetic satellite data,\nGeophys. J. Int., vol. 166 67-75\n\nInstallation\n============\n\nChaosMagPy relies on the following (some are optional):\n\n* python>=3.6\n* numpy (>=2 if python>=3.12)\n* scipy\n* pandas\n* cython\n* h5py\n* hdf5storage (>=0.2 if python>=3.12)\n* pyshp>=2.3.1\n* apexpy>=2.1.0 (optional, used for evaluating the ionospheric E-layer field)\n* matplotlib>=3.6 (optional, used for plotting)\n* lxml (optional, used for downloading latest RC-index file)\n\nSpecific installation steps for all dependencies, including optional packages,\nusing the conda/pip package managers are as follows:\n\n1. Install packages with conda:\n\n >>> conda install python numpy scipy pandas cython pyshp h5py matplotlib lxml\n\n2. Install remaining packages with pip:\n\n >>> pip install hdf5storage apexpy\n\n3. Finally, install ChaosMagPy with pip:\n\n >>> pip install chaosmagpy\n\n Alternatively, if you have downloaded the distribution archives from the\n Python Package Index (PyPI) at https://pypi.org/project/chaosmagpy/#files,\n install ChaosMagPy using the built or source distributions:\n\n >>> pip install chaosmagpy-x.x-py3-none-any.whl\n\n or\n\n >>> pip install chaosmagpy-x.x.tar.gz\n\n replacing ``x.x`` with the relevant version.\n",
"bugtrack_url": null,
"license": "\n License\n =======\n \n All ChaosMagPy source code and documentation is Copyright (C) Clemens Kloss\n and, unless explicitly stated, licensed under the MIT license.\n \n The exception is with regard to some of the stand-alone example scripts in the\n ChaosMagPy documentation gallery, which are licensed under the GNU Lesser\n General Public License as published by the Free Software Foundation, either\n version 3 of the License, or (at your option) any later version. This is\n explicitly stated in the header of these example scripts.\n \n MIT License\n -----------\n \n Copyright (C) 2025 Clemens Kloss.\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Evaluates the CHAOS geomagnetic field model and other models of Earth's magnetic field.",
"version": "0.15",
"project_urls": {
"Changelog": "https://github.com/ancklo/ChaosMagPy/blob/master/CHANGELOG.rst",
"Documentation": "https://chaosmagpy.readthedocs.io/en/",
"Homepage": "https://github.com/ancklo/ChaosMagPy",
"Issues": "https://github.com/ancklo/ChaosMagPy/issues",
"Repository": "https://github.com/ancklo/ChaosMagPy.git"
},
"split_keywords": [
"chaos",
" geomagnetic field",
" spherical harmonics model",
" secular variation",
" core field",
" crustal field",
" magnetospheric field"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f4feff832abbdb11168655a79ecf0a3821386ba569d3e21afcae482b55aca3e5",
"md5": "9e514c97fa53a635a8cac14cb34513c8",
"sha256": "7c3778134388fb2a09bb93700ab938d3612e86c94d96cafc3d4355771f8378fa"
},
"downloads": -1,
"filename": "chaosmagpy-0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e514c97fa53a635a8cac14cb34513c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 2925337,
"upload_time": "2025-07-18T11:27:17",
"upload_time_iso_8601": "2025-07-18T11:27:17.501241Z",
"url": "https://files.pythonhosted.org/packages/f4/fe/ff832abbdb11168655a79ecf0a3821386ba569d3e21afcae482b55aca3e5/chaosmagpy-0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b38a353a5a89df6fd8315fb2694baee81fb7bb5affe7e0dc8f20ef538354baf2",
"md5": "c1711c2e441b63ddf0fa45ccaec1ee92",
"sha256": "ce7bb5baed15927e554e8de409c5b38f551e59625663e5d4b790724746112a33"
},
"downloads": -1,
"filename": "chaosmagpy-0.15.tar.gz",
"has_sig": false,
"md5_digest": "c1711c2e441b63ddf0fa45ccaec1ee92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2935479,
"upload_time": "2025-07-18T11:27:19",
"upload_time_iso_8601": "2025-07-18T11:27:19.687844Z",
"url": "https://files.pythonhosted.org/packages/b3/8a/353a5a89df6fd8315fb2694baee81fb7bb5affe7e0dc8f20ef538354baf2/chaosmagpy-0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 11:27:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ancklo",
"github_project": "ChaosMagPy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.26"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.1"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"0.23"
]
]
},
{
"name": "Cython",
"specs": [
[
">=",
"0.28"
]
]
},
{
"name": "h5py",
"specs": [
[
">=",
"2.8.0"
]
]
},
{
"name": "pyshp",
"specs": [
[
">=",
"2.3.1"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.6"
]
]
},
{
"name": "hdf5storage",
"specs": [
[
">=",
"0.2"
]
]
},
{
"name": "lxml",
"specs": [
[
">=",
"4.3.4"
]
]
},
{
"name": "apexpy",
"specs": [
[
">=",
"2.1.0"
]
]
}
],
"lcname": "chaosmagpy"
}
