shipgrav
shipgrav: A Python package for marine gravimetry - Published in JOSS (2024)
Science Score: 93.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 1 DOI reference(s) in JOSS metadata -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Marine gravity processing for UNOLS (Python)
Basic Info
- Host: GitHub
- Owner: PFPE
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://shipgrav.readthedocs.io
- Size: 1.02 MB
Statistics
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 1
- Releases: 6
Metadata Files
readme.md
shipgrav
shipgrav is a Python package designed for reading, processing, and reducing marine gravity data from UNOLS ships. It is created and maintained by PFPE for the marine gravimetry community. The shipgrav repository also contains scripts with example workflows for gravity data processing and reduction.
Dependencies
python 3.9+\ numpy\ scipy\ pandas 2.0+\ statsmodels\ tomli\ pyyaml\ tqdm
To run the example scripts, you will also need matplotlib, geographiclib, and pooch. To run the example scripts in jupyter, you will also need jupyterlab and jupytext.
Installation
shipgrav can be installed from PyPI using pip. Detailed instructions are in the documentation.
Documentation and usage
The shipgrav documentation is available online at shipgrav.readthedocs.io. It can also be accessed offline by building the contents of the docs folder using sphinx.
Contributing to shipgrav
Please do! If you have ideas for how to make shipgrav better, you can raise an issue on github or contact PFPE.
If you raise an issue on github, please include as much detail as possible about any errors you are encountering or any proposed enhancements to the code. Include the text of any error messages, and if the issue is unexpected behavior from the code without any visible error messages, describe both what the code is doing and what you think it should be doing instead. PFPE may ask for additional details and/or copies of data files in order to reproduce and diagnose an issue.
Additions or enhancements to the code are also welcome. Contributors are invited to fork the repository and submit pull requests for the maintainers to review.
Owner
- Name: Potential Field Pool Equipment
- Login: PFPE
- Kind: organization
- Repositories: 1
- Profile: https://github.com/PFPE
JOSS Publication
shipgrav: A Python package for marine gravimetry
Authors
Woods Hole Oceanographic Institution, USA
Woods Hole Oceanographic Institution, USA
Woods Hole Oceanographic Institution, USA
Dynamic Gravity Systems, USA
Woods Hole Oceanographic Institution, USA
Editor
Rachel Wegener
Tags
gravity marine geophysics UNOLSGitHub Events
Total
- Create event: 7
- Release event: 4
- Issues event: 23
- Watch event: 2
- Delete event: 2
- Member event: 1
- Issue comment event: 29
- Push event: 31
- Pull request event: 6
- Fork event: 1
Last Year
- Create event: 7
- Release event: 4
- Issues event: 23
- Watch event: 2
- Delete event: 2
- Member event: 1
- Issue comment event: 29
- Push event: 31
- Pull request event: 6
- Fork event: 1
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Hannah Mark | h****k@g****m | 97 |
| malmans2 | m****i@b****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 15
- Total pull requests: 4
- Average time to close issues: 3 days
- Average time to close pull requests: about 10 hours
- Total issue authors: 3
- Total pull request authors: 2
- Average comments per issue: 1.87
- Average comments per pull request: 1.0
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 15
- Pull requests: 4
- Average time to close issues: 3 days
- Average time to close pull requests: about 10 hours
- Issue authors: 3
- Pull request authors: 2
- Average comments per issue: 1.87
- Average comments per pull request: 1.0
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- andreww (8)
- malmans2 (5)
- hfmark (2)
Pull Request Authors
- hfmark (6)
- malmans2 (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 27 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 6
- Total maintainers: 1
pypi.org: shipgrav
Functions for marine gravity data processing and reduction
- Documentation: https://shipgrav.readthedocs.io/
- License: GNU General Public License v3 (GPLv3)
-
Latest release: 1.0.6
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- alabaster *
- decorator *
- numpy *
- pandas *
- pyyaml *
- scipy *
- sphinx *
- statsmodels *
- tomli *
- matplotlib *
- numpy *
- pandas *
- pyyaml *
- scipy *
- statsmodels *
- tomli *
- actions/checkout v4 composite
- codecov/codecov-action v3 composite
- conda-incubator/setup-miniconda v3 composite