Metadata-Version: 2.4
Name: pygeoid
Version: 0.0.5
Summary: Python toolkit for physical geodesy
Author: Ilya Oshchepkov
License: MIT
Keywords: geodesy,gravimetry,gravity,geoid
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pyproj
Requires-Dist: astropy
Requires-Dist: pandas
Requires-Dist: joblib
Requires-Dist: pyshtools
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=8; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: jupyter; extra == "docs"
Dynamic: license-file

<p align="center">
  <img src="logo/pygeoid_logo_red_blue_with_text_200dpi.png" width="420" alt="PyGeoid">
</p>

<!-- DOCS-START -->

<p align="center">
  Gravity field modelling and computational geodesy in Python
</p>

<p align="center">
  <a href="https://pypi.org/project/pygeoid/">
    <img src="https://img.shields.io/pypi/v/pygeoid"
      alt="PyPI version">
  </a>
  <a href="https://pypi.org/project/pygeoid/">
    <img src="https://img.shields.io/pypi/pyversions/pygeoid"
      alt="Python versions">
  </a>
  <a href="https://pypi.org/project/pygeoid/">
    <img src="https://img.shields.io/pypi/status/pygeoid"
      alt="Development Status">
  </a>
</p>
<p align="center">
  <a href="https://github.com/ioshchepkov/pygeoid/actions">
    <img src="https://img.shields.io/github/actions/workflow/status/ioshchepkov/pygeoid/ci.yml?branch=master"
      alt="CI">
  </a>
  <a href="https://coveralls.io/github/ioshchepkov/pygeoid">
    <img src="https://coveralls.io/repos/github/ioshchepkov/pygeoid/badge.svg"
      alt="Tests coverage">
  </a>
  <a href="https://pygeoid.thegeodesy.com">
    <img src="https://app.readthedocs.org/projects/pygeoid/badge/?version=master"
      alt="Documentation Status">
  </a>
</p>
<p align="center">
  <a href="https://doi.org/10.5281/zenodo.4692429">
    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4692429.svg"
      alt="DOI">
  </a>
  <a href="https://github.com/ioshchepkov/pygeoid/blob/develop/LICENSE.txt">
    <img src="https://img.shields.io/github/license/ioshchepkov/pygeoid"
      alt="License">
  </a>
</p>

## Overview

PyGeoid implements computational methods for modelling and analysing 
the Earth's gravity field and related geodetic quantities.

The library is intended for research and educational use in geodesy.

The project is under **active development**.
APIs may and will change between minor versions.

## Installation

Install from `PyPI`:

```bash
pip install pygeoid
```

Install development version:

```bash
pip install -U git+https://github.com/ioshchepkov/pygeoid@develop
```

## Documentation

https://pygeoid.thegeodesy.com

## Citation

If you use PyGeoid in academic work, please cite it.

Citation metadata is available in:

- `CITATION.cff`
- Zenodo DOI: https://doi.org/10.5281/zenodo.4692429

## Contributing

Contributions related to theory, algorithms, validation, and documentation are welcome.

For substantial changes, please open an issue first to discuss your proposal.

Participation in this project is governed by the Code of Conduct.

# License

MIT License.
