chaosmagpy


Namechaosmagpy JSON
Version 0.14 PyPI version JSON
download
home_pageNone
SummaryEvaluates the CHAOS geomagnetic field model and other models of Earth's magnetic field.
upload_time2024-06-21 08:33:05
maintainerNone
docs_urlNone
authorNone
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) 2024 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 No requirements were recorded.
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-7/. To
quickly get started, download the complete working example including the latest
model under the "Forward code" section.

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<=1.26 (loading MAT-files fails in v2.0, waiting for fix in hdf5storage)
* scipy
* pandas
* cython
* h5py
* hdf5storage>0.1.17
* pyshp>=2.3.1
* matplotlib>=3.6 (optional, used for plotting)
* lxml (optional, used for downloading latest RC-index file)

Specific installation steps using the conda/pip package managers are as follows:

1. Install packages with conda:

   >>> conda install python "numpy<2" scipy pandas cython pyshp h5py matplotlib lxml

2. Install remaining packages with pip:

   >>> pip install hdf5storage

3. Finally install ChaosMagPy either with pip from PyPI:

   >>> pip install chaosmagpy

   Or, 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 distribution:

   >>> pip install chaosmagpy-x.x-py3-none-any.whl

   replacing  ``x.x`` with the relevant version, or using the source
   distribution:

   >>> pip install chaosmagpy-x.x.tar.gz

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/25/1b/5c959ced497c77e3fbf838964e7cc2292a074db321c807868e6b3da0e66d/chaosmagpy-0.14.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-7/. To\nquickly get started, download the complete working example including the latest\nmodel under the \"Forward code\" section.\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<=1.26 (loading MAT-files fails in v2.0, waiting for fix in hdf5storage)\n* scipy\n* pandas\n* cython\n* h5py\n* hdf5storage>0.1.17\n* pyshp>=2.3.1\n* matplotlib>=3.6 (optional, used for plotting)\n* lxml (optional, used for downloading latest RC-index file)\n\nSpecific installation steps using the conda/pip package managers are as follows:\n\n1. Install packages with conda:\n\n   >>> conda install python \"numpy<2\" scipy pandas cython pyshp h5py matplotlib lxml\n\n2. Install remaining packages with pip:\n\n   >>> pip install hdf5storage\n\n3. Finally install ChaosMagPy either with pip from PyPI:\n\n   >>> pip install chaosmagpy\n\n   Or, if you have downloaded the distribution archives from the Python Package\n   Index (PyPI) at https://pypi.org/project/chaosmagpy/#files, install\n   ChaosMagPy using the built distribution:\n\n   >>> pip install chaosmagpy-x.x-py3-none-any.whl\n\n   replacing  ``x.x`` with the relevant version, or using the source\n   distribution:\n\n   >>> pip install chaosmagpy-x.x.tar.gz\n",
    "bugtrack_url": null,
    "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) 2024 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. ",
    "summary": "Evaluates the CHAOS geomagnetic field model and other models of Earth's magnetic field.",
    "version": "0.14",
    "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": "",
            "digests": {
                "blake2b_256": "48d5386c815f30409fd753f038c747a15505241840e79cf1b5c7d4177072f36b",
                "md5": "7478664bf2fadc066427525542a899f9",
                "sha256": "d292f73783b06521b23ab32c83e22f2aa71bd9a960c43774145df02ad482f548"
            },
            "downloads": -1,
            "filename": "chaosmagpy-0.14-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7478664bf2fadc066427525542a899f9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 2832637,
            "upload_time": "2024-06-21T08:33:01",
            "upload_time_iso_8601": "2024-06-21T08:33:01.649244Z",
            "url": "https://files.pythonhosted.org/packages/48/d5/386c815f30409fd753f038c747a15505241840e79cf1b5c7d4177072f36b/chaosmagpy-0.14-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "251b5c959ced497c77e3fbf838964e7cc2292a074db321c807868e6b3da0e66d",
                "md5": "38c7786a2463c323893f7346d5d0305c",
                "sha256": "8f7fbdca18dd3264923a01de5cbdbceb89816ef26fda33f2a9bdf0047fdca905"
            },
            "downloads": -1,
            "filename": "chaosmagpy-0.14.tar.gz",
            "has_sig": false,
            "md5_digest": "38c7786a2463c323893f7346d5d0305c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 2841052,
            "upload_time": "2024-06-21T08:33:05",
            "upload_time_iso_8601": "2024-06-21T08:33:05.813995Z",
            "url": "https://files.pythonhosted.org/packages/25/1b/5c959ced497c77e3fbf838964e7cc2292a074db321c807868e6b3da0e66d/chaosmagpy-0.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-21 08:33:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ancklo",
    "github_project": "ChaosMagPy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "chaosmagpy"
}
None
Elapsed time: 0.60503s