apexpy

A Python wrapper for Apex coordinates

https://github.com/aburrell/apexpy

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 8 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
3 of 11 committers (27.3%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary

Last synced: 6 months ago · JSON representation

Repository

A Python wrapper for Apex coordinates

Basic Info

Host: GitHub
Owner: aburrell
License: mit
Language: Python
Default Branch: main
Size: 2.08 MB

Statistics

Stars: 35
Watchers: 4
Forks: 28
Open Issues: 17
Releases: 7

Created over 10 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Authors Zenodo

README.rst

|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 `_.

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 `_.

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:: https://github.com/aburrell/apexpy/blob/main/docs/apexpy.png?raw=true
   :alt: ApexPy logo: yellow magnetic field lines surrounding the Earth's surface, which is blue

Owner

Name: Angeline Burrell
Login: aburrell
Kind: user
Location: Washington D.C.
Company: Naval Research Laboratory

Repositories: 3
Profile: https://github.com/aburrell

Research Physicist at the Naval Research Laboratory

GitHub Events

Total

Create event: 5
Release event: 1
Issues event: 16
Watch event: 2
Delete event: 5
Issue comment event: 42
Push event: 36
Pull request review comment event: 11
Pull request review event: 22
Pull request event: 19
Fork event: 3

Last Year

Create event: 5
Release event: 1
Issues event: 16
Watch event: 2
Delete event: 5
Issue comment event: 42
Push event: 36
Pull request review comment event: 11
Pull request review event: 22
Pull request event: 19
Fork event: 3

Committers

Last synced: 10 months ago

All Time

Total Commits: 1,357
Total Committers: 11
Avg Commits per committer: 123.364
Development Distribution Score (DDS): 0.455

Past Year

Commits: 115
Committers: 4
Avg Commits per committer: 28.75
Development Distribution Score (DDS): 0.087

Top Committers

Name	Email	Commits
Angeline Burrell	a**l@n**l	739
Christer van der Meeren	c**n@g**m	387
Gregory Starr	g**r@b**u	79
Leslie Lamarche	l**e@s**m	53
aburrell	a**3@l**k	40
Ashton Reimer	a**r@g**m	28
aburrell	a**0@u**u	13
Jeff Klenzing	1****g	6
Ashton Reimer	a**r@s**m	6
Achim Morschhauser	2****a	4
Ingo Michaelis	m**i@g**e	2

Committer Domains (Top 20 + Academic)

sri.com: 2 gfz-potsdam.de: 1 utdallas.edu: 1 le.ac.uk: 1 bu.edu: 1 nrl.navy.mil: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 71
Total pull requests: 65
Average time to close issues: 6 months
Average time to close pull requests: about 2 months
Total issue authors: 26
Total pull request authors: 10
Average comments per issue: 3.2
Average comments per pull request: 3.12
Merged pull requests: 55
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 8
Pull requests: 16
Average time to close issues: about 1 month
Average time to close pull requests: 9 days
Issue authors: 3
Pull request authors: 4
Average comments per issue: 0.0
Average comments per pull request: 3.19
Merged pull requests: 14
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

aburrell (26)
ljlamarche (11)
gregstarr (5)
asreimer (5)
bharding512 (2)
smithara (2)
sterfrag (1)
JouleCai (1)
saigowtam14 (1)
jklenzing (1)
victoriyaforsythe (1)
Ensase (1)
rstoneback (1)
jpreistad (1)
SanaShaukat (1)

Pull Request Authors

aburrell (42)
ljlamarche (9)
gregstarr (7)
jklenzing (6)
asreimer (2)
ingomichaelis (2)
sputnik-a (2)
scivision (1)
codacy-badger (1)
Cadair (1)

Top Labels

Issue Labels

bug (26) enhancement (11) question (10) documentation (10) wontfix (2)

Pull Request Labels

bug (6) documentation (3) enhancement (1)

Packages

Total packages: 1
Total downloads:
- pypi 1,008 last-month

Total dependent packages: 9
Total dependent repositories: 10
Total versions: 9
Total maintainers: 1

pypi.org: apexpy

A Python wrapper for Apex coordinates

Documentation: https://apexpy.readthedocs.io/
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.
Latest release: 2.1.0
published about 1 year ago

Versions: 9
Dependent Packages: 9
Dependent Repositories: 10
Downloads: 1,008 Last month
Docker Downloads: 0

Rankings

Dependent packages count: 1.2%

Docker downloads count: 4.3%

Dependent repos count: 4.6%

Average: 7.2%

Forks count: 8.7%

Stargazers count: 11.6%

Downloads: 12.5%

Maintainers (1)

aburrell

Last synced: 7 months ago

Dependencies

docs/requirements.txt pypi

sphinx >=1.3

.github/workflows/docs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/main.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

apexpy

Science Score: 59.0%

Repository

Basic Info

Statistics

Metadata Files

README.rst

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: apexpy

Rankings

Maintainers (1)

Dependencies