Skip to main content

shipgrav

build status codecov

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.

Metadata

Release files for shipgrav 1.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shipgrav 1.0.11
File Size Uploaded Provenance Actions
shipgrav-1.0.11.tar.gz 613.7 kB With provenance Details for shipgrav-1.0.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for shipgrav 1.0.11
File Interpreter ABI Platform Actions
shipgrav-1.0.11-py2.py3-none-any.whl Python 3, Python 2 none any Details for shipgrav-1.0.11-py2.py3-none-any.whl

Total release size: 775.6 kB

Release files / shipgrav-1.0.11.tar.gz

Download URL shipgrav-1.0.11.tar.gz
Size 613.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f7f42fa9b85de7969503c0ac0fdfac53ae82ef90e7a92a69443ec2a7f25f9acc
BLAKE2b-256 checksum
How to use checksums
b1fd58e58ed42575480eb20e5a562ee2d310cd1618cc7ddcaee3c6a2f9d8acd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 10, 2026.

Transparency log

Release files / shipgrav-1.0.11-py2.py3-none-any.whl

Download URL shipgrav-1.0.11-py2.py3-none-any.whl
Size 162.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a505f6dd0d354841326e8a4051a9b9ed3538fb4ba160332108bb21e8cfd1784b
BLAKE2b-256 checksum
How to use checksums
8585f5f7af408f4cbd1f7df97bcfaf219e502c418701866b9239fb8e0884a8d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 10, 2026.

Transparency log

Security for shipgrav 1.0.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for shipgrav-1.0.11.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 10, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page