Metadata-Version: 2.1
Name: chaosmagpy
Version: 0.3
Summary: Evaluate the CHAOS geomagnetic field model.
Home-page: https://github.com/ancklo/ChaosMagPy
Author: Clemens Kloss
Author-email: ancklo@space.dtu.dk
License: MIT
Description: 
        Overview
        ========
        
        ChaosMagPy is a simple Python package for evaluating the
        `CHAOS-7 <http://www.spacecenter.dk/files/magnetic-models/CHAOS-7/>`_ geomagnetic
        field model. To quickly get started, download a complete working example
        including the latest model under the "Forward code" section.
        
        | **Release:** v0.3
        | **Version of CHAOS:** CHAOS-7.2 (0702)
        
        Documentation
        -------------
        
        The documentation of the current release is available on
        `Read the Docs <https://chaosmagpy.readthedocs.io/en/stable/>`_.
        
        |doi| |docs| |license|
        
        .. |docs| image:: https://readthedocs.org/projects/chaosmagpy/badge/?version=stable
           :target: https://chaosmagpy.readthedocs.io/en/stable/?badge=stable
           :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
        
        References
        ----------
        
        To reference ChaosMagPy in publications, please cite the package itself
        
        https://doi.org/10.5281/zenodo.3352398
        
        and 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
        
        License
        =======
        
        MIT License
        
        Copyright (c) 2020 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.
        
        Installation
        ============
        
        ChaosMagPy relies on the following:
        
        * python>=3.6
        * numpy
        * scipy
        * pandas
        * cython
        * h5py
        * cartopy>=0.17
        * matplotlib>=3
        * cdflib
        * hdf5storage
        
        Specific installation steps using the conda/pip package managers are as follows:
        
        1. Install packages with conda:
        
           >>> conda install python numpy scipy pandas cython cartopy matplotlib h5py
        
        2. Install packages with pip:
        
           >>> pip install cdflib hdf5storage
        
        3. Finally install ChaosMagPy either with pip from PyPI:
        
           >>> pip install chaosmagpy
        
           or, if you have downloaded the `package files <https://pypi.org/project/chaosmagpy/#files>`_
           to the current working directory, with:
        
           >>> pip install chaosmagpy-x.x-py3-none-any.whl
        
           or, alternatively
        
           >>> pip install chaosmagpy-x.x.tar.gz
        
           replacing ``x.x`` with the correct version.
        
Keywords: CHAOS,geomagnetic field,spherical harmonics model,secular variation,core field,crustal field
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >= 3.6
Description-Content-Type: text/x-rst
