conjugate-map
Files and scripts relating to geomagnetic conjugate maps.
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.0%) to scientific vocabulary
Last synced: 6 months ago
·
JSON representation
·
Repository
Files and scripts relating to geomagnetic conjugate maps.
Basic Info
Statistics
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 3
- Releases: 5
Created over 2 years ago
· Last pushed 7 months ago
Metadata Files
Readme
Changelog
Contributing
License
Code of conduct
Citation
Zenodo
README.rst
conjugate_map ============= |PyPI version| |DOI| |Documentation Status| |Coverage Status| |Test Status| Files and scripts relating to geomagnetic conjugate map. Run in Binder here: |Binder| There are two example notebooks available: - ``MWE.ipynb``: Minimal working example demonstrating conjugate calculations. - ``ConjugateMap.ipynb``: More in-depth examples using COMNAP, Madrigal and other databases to produce animated maps with plotly express. The following functions are imported from ``conj_calc.py``: - ``conjugate_map.findconj()`` : function to compute conjugate points for a given location at a given time and date. - ``conjugate_map.conjcalc()`` : function to take in a dataframe and add columns for all stages of calculating conjugate points. - ``conjugate_map.calc_mlat_rings()`` : function to calculate magnetic graticules for a given latitude and datetime. You can read the documentation for each function by running, e.g., ``help(calc_mlat_rings)``. Installation ------------ To install from pypi: ``pip install conjugate-map`` To install from source: Clone git repo and run ``python -m pip install .`` from top level of directory. Testing ------- To test locally, run ``python -m unittest`` from top level of directory. .. |PyPI version| image:: https://badge.fury.io/py/conjugate-map.svg :target: https://badge.fury.io/py/conjugate-map .. |DOI| image:: https://zenodo.org/badge/651410906.svg :target: https://zenodo.org/doi/10.5281/zenodo.10056623 .. |Documentation Status| image:: https://readthedocs.org/projects/conjugate-map/badge/?version=latest :target: https://conjugate-map.readthedocs.io/en/latest/?badge=latest .. |Coverage Status| image:: https://coveralls.io/repos/github/KCollins/conjugate_map/badge.svg?branch=main :target: https://coveralls.io/github/KCollins/conjugate_map/?branch=main .. |Test Status| image:: https://github.com/KCollins/conjugate_map/actions/workflows/main.yml/badge.svg?branch=main :target: https://github.com/KCollins/conjugate_map/actions/workflows/main.yml .. |Binder| image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/KCollins/conjugate_map/HEAD?labpath=notebooks%2FMWE.ipynb
Owner
- Login: KCollins
- Kind: user
- Repositories: 4
- Profile: https://github.com/KCollins
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Collins
given-names: Kristina
orcid: https://orcid.org/0000-0002-3816-1948
- family-names: Burrell
given-names: Angeline
orcid: https://orcid.org/0000-0001-8875-9326
title: "conjugate-map"
version: 1
doi: 10.5281/zenodo.10056623
date-released: 2023-10-02
GitHub Events
Total
- Create event: 2
- Release event: 5
- Issues event: 2
- Watch event: 6
- Delete event: 1
- Issue comment event: 13
- Push event: 58
- Pull request review comment event: 6
- Pull request review event: 10
- Pull request event: 4
Last Year
- Create event: 2
- Release event: 5
- Issues event: 2
- Watch event: 6
- Delete event: 1
- Issue comment event: 13
- Push event: 58
- Pull request review comment event: 6
- Pull request review event: 10
- Pull request event: 4
Packages
- Total packages: 1
-
Total downloads:
- pypi 21 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
pypi.org: conjugate-map
Library for computing geomagnetic conjugate points.
- Documentation: https://conjugate-map.readthedocs.io/
- License: MIT License Copyright (c) 2023 Kristina Collins 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: 0.3.0
published 10 months ago
Rankings
Dependent packages count: 10.9%
Average: 36.2%
Dependent repos count: 61.4%
Maintainers (1)
Last synced:
7 months ago
Dependencies
requirements.txt
pypi
- aacgmv2 *
- datetime *
- geopack *
- geopandas *
- gpxpy *
- lxml *
- numpy *
- ogr *
- os *
- pandas *
- plotly.express *
- xlrd *