| Name | apexpy JSON |
| Version |
2.0.2
JSON |
| download |
| home_page | None |
| Summary | A Python wrapper for Apex coordinates |
| upload_time | 2024-11-12 14:39:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.9 |
| license | The MIT License (MIT) Copyright (c) 2015 Christer van der Meeren 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 |
apex
modified apex
quasi-dipole
quasi dipole
coordinates
magnetic coordinates
mlt
magnetic local time
conversion
converting
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|logo|
========
Overview
========
|docs| |version| |doi|
This is a Python wrapper for the Apex fortran library by
Emmert et al. [2010] [1]_, which allows converting between geodetic, modified
apex, and quasi-dipole coordinates as well as getting modified apex and
quasi-dipole base vectors (Richmond [1995] [2]_). The geodetic system used here
is WGS84. MLT calculations are also included. The package is free software
(MIT license).
Quick start
===========
Install from PyPI using ``pip``::
pip install apexpy
This assumes that the same version of libgfortran is installed in the same
location as when the pip wheel was built (if a wheel was used). If not, you may
have trouble importing apexpy. If you run into trouble, try the command::
pip install --no-binary :apexpy: apexpy
which requires both libgfortran and gfortran to be installed on your system.
More detailed installation instructions (and troubleshooting) is available
in the
`documentation <https://apexpy.readthedocs.io/en/latest/installation.html>`_.
Conversion is done by creating an ``Apex`` object and using its methods to
perform the desired calculations. Some simple examples::
from apexpy import Apex
import datetime as dt
atime = dt.datetime(2015, 2, 10, 18, 0, 0)
apex15 = Apex(date=2015.3) # dt.date and dt.datetime objects also work
# Geodetic to apex, scalar input
mlat, mlon = apex15.convert(60, 15, 'geo', 'apex', height=300)
print("{:.12f}, {:.12f}".format(mlat, mlon))
57.477310180664, 93.590156555176
# Apex to geodetic, array input
glat, glon = apex15.convert([90, -90], 0, 'apex', 'geo', height=0)
print(["{:.12f}, {:.12f}".format(ll, glon[i]) for i,ll in enumerate(glat)])
['83.103820800781, -84.526657104492', '-74.388252258301, 125.736274719238']
# Geodetic to magnetic local time
mlat, mlt = apex15.convert(60, 15, 'geo', 'mlt', datetime=atime)
print("{:.12f}, {:.12f}".format(mlat, mlt))
56.598316192627, 19.107861709595
# can also convert magnetic longitude to mlt
mlt = apex15.mlon2mlt(120, atime)
print("{:.2f}".format(mlt))
20.90
If you don't know or use Python, you can also use the command line. See details
in the full documentation (link in the section below).
Documentation
=============
https://apexpy.readthedocs.io/en/latest
References
==========
.. [1] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
A computationally compact representation of Magnetic-Apex
and Quasi-Dipole coordinates with smooth base vectors,
J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
.. [2] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
Magnetic Apex Coordinates, Journal of geomagnetism and
geoelectricity, 47(2), 191–212,
`doi:10.5636/jgg.47.191 <http://dx.doi.org/10.5636/jgg.47.191>`_.
Badges
======
.. list-table::
:stub-columns: 1
* - docs
- |docs|
* - tests
- | |ghactions|
| |coveralls| |codeclimate|
| |scrutinizer| |codacy|
* - package
- | |version| |supported-versions|
| |wheel| |supported-implementations|
.. |docs| image:: https://readthedocs.org/projects/apexpy/badge/?style=flat
:target: https://apexpy.readthedocs.io/en/latest/
:alt: Documentation Status
.. |ghactions| image:: https://github.com/aburrell/apexpy/actions/workflows/main.yml/badge.svg
:alt: GitHub Actions Build Status
:target: https://github.com/aburrell/apexpy/actions/workflows/main.yml
.. |coveralls| image:: https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_98.svg
:alt: Coverage Status
:target: https://coveralls.io/github/aburrell/apexpy?branch=main
.. |codacy| image:: https://api.codacy.com/project/badge/Grade/7d4c1a6c60e747ca95cdf97746c39cda
:alt: Codacy Badge
:target: https://app.codacy.com/gh/aburrell/apexpy?utm_source=github.com&utm_medium=referral&utm_content=aburrell/apexpy&utm_campaign=Badge_Grade
.. |codeclimate| image:: https://api.codeclimate.com/v1/badges/da1d972dee790da595f8/maintainability.svg
:target: https://codeclimate.com/github/aburrell/apexpy
:alt: CodeClimate Quality Status
.. |version| image:: https://img.shields.io/pypi/v/apexpy.svg?style=flat
:alt: PyPI Package latest release
:target: https://pypi.org/project/apexpy/
.. |downloads| image:: https://img.shields.io/pypi/dm/apexpy.svg?style=flat
:alt: PyPI Package monthly downloads
:target: https://pypi.org/project/apexpy
.. |wheel| image:: https://img.shields.io/pypi/wheel/apexpy.svg?style=flat
:alt: PyPI Wheel
:target: https://pypi.org/project/apexpy
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/apexpy.svg?style=flat
:alt: Supported versions
:target: https://pypi.org/project/apexpy
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/apexpy.svg?style=flat
:alt: Supported implementations
:target: https://pypi.org/project/apexpy
.. |scrutinizer| image:: https://img.shields.io/scrutinizer/quality/g/aburrell/apexpy/main.svg?style=flat
:alt: Scrutinizer Status
:target: https://scrutinizer-ci.com/g/aburrell/apexpy/
.. |doi| image:: https://www.zenodo.org/badge/doi/10.5281/zenodo.4585641.svg
:target: https://doi.org/10.5281/zenodo.1214206
.. |logo| image:: docs/apexpy.png
:alt: ApexPy logo: yellow magnetic field lines surrounding the Earth's surface, which is blue
Raw data
{
"_id": null,
"home_page": null,
"name": "apexpy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": "Angeline Burrell <angeline.g.burrell.civ@us.navy.mil>",
"keywords": "apex, modified apex, quasi-dipole, quasi dipole, coordinates, magnetic coordinates, mlt, magnetic local time, conversion, converting",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/fb/b4/0200daa7a3e343728c1815ec9ed53d35c11416fda86c189c2c878655af18/apexpy-2.0.2.tar.gz",
"platform": null,
"description": "|logo|\n\n========\nOverview\n========\n\n|docs| |version| |doi|\n\nThis is a Python wrapper for the Apex fortran library by\nEmmert et al. [2010] [1]_, which allows converting between geodetic, modified\napex, and quasi-dipole coordinates as well as getting modified apex and\nquasi-dipole base vectors (Richmond [1995] [2]_). The geodetic system used here\nis WGS84. MLT calculations are also included. The package is free software\n(MIT license).\n\nQuick start\n===========\n\nInstall from PyPI using ``pip``::\n\n pip install apexpy\n\nThis assumes that the same version of libgfortran is installed in the same\nlocation as when the pip wheel was built (if a wheel was used). If not, you may\nhave trouble importing apexpy. If you run into trouble, try the command::\n\n pip install --no-binary :apexpy: apexpy\n\nwhich requires both libgfortran and gfortran to be installed on your system.\nMore detailed installation instructions (and troubleshooting) is available\nin the\n`documentation <https://apexpy.readthedocs.io/en/latest/installation.html>`_.\n\nConversion is done by creating an ``Apex`` object and using its methods to\nperform the desired calculations. Some simple examples::\n\n from apexpy import Apex\n import datetime as dt\n atime = dt.datetime(2015, 2, 10, 18, 0, 0)\n apex15 = Apex(date=2015.3) # dt.date and dt.datetime objects also work\n\n # Geodetic to apex, scalar input\n mlat, mlon = apex15.convert(60, 15, 'geo', 'apex', height=300)\n print(\"{:.12f}, {:.12f}\".format(mlat, mlon))\n 57.477310180664, 93.590156555176\n\n # Apex to geodetic, array input\n glat, glon = apex15.convert([90, -90], 0, 'apex', 'geo', height=0)\n print([\"{:.12f}, {:.12f}\".format(ll, glon[i]) for i,ll in enumerate(glat)])\n ['83.103820800781, -84.526657104492', '-74.388252258301, 125.736274719238']\n\n # Geodetic to magnetic local time\n mlat, mlt = apex15.convert(60, 15, 'geo', 'mlt', datetime=atime)\n print(\"{:.12f}, {:.12f}\".format(mlat, mlt))\n 56.598316192627, 19.107861709595\n\n # can also convert magnetic longitude to mlt\n mlt = apex15.mlon2mlt(120, atime)\n print(\"{:.2f}\".format(mlt))\n 20.90\n\nIf you don't know or use Python, you can also use the command line. See details\nin the full documentation (link in the section below).\n\nDocumentation\n=============\n\nhttps://apexpy.readthedocs.io/en/latest\n\nReferences\n==========\n\n.. [1] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),\n A computationally compact representation of Magnetic-Apex\n and Quasi-Dipole coordinates with smooth base vectors,\n J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.\n\n.. [2] Richmond, A. D. (1995), Ionospheric Electrodynamics Using\n Magnetic Apex Coordinates, Journal of geomagnetism and\n geoelectricity, 47(2), 191\u2013212,\n `doi:10.5636/jgg.47.191 <http://dx.doi.org/10.5636/jgg.47.191>`_.\n\nBadges\n======\n\n.. list-table::\n :stub-columns: 1\n\n * - docs\n - |docs|\n * - tests\n - | |ghactions|\n | |coveralls| |codeclimate|\n | |scrutinizer| |codacy|\n * - package\n - | |version| |supported-versions|\n | |wheel| |supported-implementations|\n\n.. |docs| image:: https://readthedocs.org/projects/apexpy/badge/?style=flat\n :target: https://apexpy.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. |ghactions| image:: https://github.com/aburrell/apexpy/actions/workflows/main.yml/badge.svg\n :alt: GitHub Actions Build Status\n :target: https://github.com/aburrell/apexpy/actions/workflows/main.yml\n\n.. |coveralls| image:: https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_98.svg\n :alt: Coverage Status\n :target: https://coveralls.io/github/aburrell/apexpy?branch=main\n\n.. |codacy| image:: https://api.codacy.com/project/badge/Grade/7d4c1a6c60e747ca95cdf97746c39cda\n :alt: Codacy Badge\n :target: https://app.codacy.com/gh/aburrell/apexpy?utm_source=github.com&utm_medium=referral&utm_content=aburrell/apexpy&utm_campaign=Badge_Grade\n\n.. |codeclimate| image:: https://api.codeclimate.com/v1/badges/da1d972dee790da595f8/maintainability.svg\n :target: https://codeclimate.com/github/aburrell/apexpy\n :alt: CodeClimate Quality Status\n\n.. |version| image:: https://img.shields.io/pypi/v/apexpy.svg?style=flat\n :alt: PyPI Package latest release\n :target: https://pypi.org/project/apexpy/\n\n.. |downloads| image:: https://img.shields.io/pypi/dm/apexpy.svg?style=flat\n :alt: PyPI Package monthly downloads\n :target: https://pypi.org/project/apexpy\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/apexpy.svg?style=flat\n :alt: PyPI Wheel\n :target: https://pypi.org/project/apexpy\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/apexpy.svg?style=flat\n :alt: Supported versions\n :target: https://pypi.org/project/apexpy\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/apexpy.svg?style=flat\n :alt: Supported implementations\n :target: https://pypi.org/project/apexpy\n\n.. |scrutinizer| image:: https://img.shields.io/scrutinizer/quality/g/aburrell/apexpy/main.svg?style=flat\n :alt: Scrutinizer Status\n :target: https://scrutinizer-ci.com/g/aburrell/apexpy/\n\n.. |doi| image:: https://www.zenodo.org/badge/doi/10.5281/zenodo.4585641.svg\n :target: https://doi.org/10.5281/zenodo.1214206\n\n.. |logo| image:: docs/apexpy.png\n :alt: ApexPy logo: yellow magnetic field lines surrounding the Earth's surface, which is blue\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2015 Christer van der Meeren 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": "A Python wrapper for Apex coordinates",
"version": "2.0.2",
"project_urls": {
"documentation": "https://apexpy.readthedocs.io/en/latest/",
"download": "https://github.com/aburrell/apexpy/releases",
"source": "https://github.com/aburrell/apexpy",
"tracker": "https://github.com/aburrell/apexpy/issues"
},
"split_keywords": [
"apex",
" modified apex",
" quasi-dipole",
" quasi dipole",
" coordinates",
" magnetic coordinates",
" mlt",
" magnetic local time",
" conversion",
" converting"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8701809c1fce3ab45bb46078a8b691bbae270ab201fce5df1605f0dfdb389cce",
"md5": "b640fa2cddb84cff4605c763b4b3ed4d",
"sha256": "6e513962e8437010ca5096183113454acf56c564263e9ddf2d9fec01abe83937"
},
"downloads": -1,
"filename": "apexpy-2.0.2-cp310-cp310-macosx_14_0_arm64.whl",
"has_sig": false,
"md5_digest": "b640fa2cddb84cff4605c763b4b3ed4d",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": "<3.12,>=3.9",
"size": 276239,
"upload_time": "2024-11-12T14:39:40",
"upload_time_iso_8601": "2024-11-12T14:39:40.482518Z",
"url": "https://files.pythonhosted.org/packages/87/01/809c1fce3ab45bb46078a8b691bbae270ab201fce5df1605f0dfdb389cce/apexpy-2.0.2-cp310-cp310-macosx_14_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fbb40200daa7a3e343728c1815ec9ed53d35c11416fda86c189c2c878655af18",
"md5": "43f60a34a39237784d18eb693cff9b08",
"sha256": "d1e7d8c3302122cac5565bf3f43575d76cdcf1e648bb4495794cc6d8bc98a4ab"
},
"downloads": -1,
"filename": "apexpy-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "43f60a34a39237784d18eb693cff9b08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 331366,
"upload_time": "2024-11-12T14:39:42",
"upload_time_iso_8601": "2024-11-12T14:39:42.056134Z",
"url": "https://files.pythonhosted.org/packages/fb/b4/0200daa7a3e343728c1815ec9ed53d35c11416fda86c189c2c878655af18/apexpy-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 14:39:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aburrell",
"github_project": "apexpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "apexpy"
}
