Metadata-Version: 2.4
Name: geoips
Version: 2.0.0a0
Summary: Geolocated Information Processing System
License-File: LICENSE
Keywords: GeoIPS,Poetry
Author: GeoIPS
Author-email: geoips@nrlmry.navy.mil
Maintainer: GeoIPS
Maintainer-email: geoips@nrlmry.navy.mil
Requires-Python: >=3.11.0,<3.13.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: debug
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: lint
Provides-Extra: test
Requires-Dist: alphashape (>=1.3.1)
Requires-Dist: autodoc-pydantic (>=2.0.0) ; extra == "doc"
Requires-Dist: bandit ; extra == "lint"
Requires-Dist: black ; extra == "lint"
Requires-Dist: brassy (>=0.0.3) ; extra == "doc"
Requires-Dist: cartopy (>=0.23.0)
Requires-Dist: colorama
Requires-Dist: doc8 ; extra == "lint"
Requires-Dist: ephem
Requires-Dist: flake8 ; extra == "lint"
Requires-Dist: flake8-docstrings ; extra == "lint"
Requires-Dist: flake8-rst ; extra == "lint"
Requires-Dist: flake8-rst-docstrings ; extra == "lint"
Requires-Dist: geoips-yaml-utils
Requires-Dist: h5py
Requires-Dist: hdf5plugin
Requires-Dist: ipython ; extra == "debug"
Requires-Dist: isodate
Requires-Dist: jsonschema (>4.18.0)
Requires-Dist: matplotlib (>=3.7.0,<3.11)
Requires-Dist: myst-parser (>=2.0.0,<3.0.0) ; extra == "doc"
Requires-Dist: netcdf4 (>1.7.0)
Requires-Dist: numexpr
Requires-Dist: numpy (>=2.3.0)
Requires-Dist: pinkrst ; extra == "lint"
Requires-Dist: pixelmatch ; extra == "test"
Requires-Dist: platformdirs
Requires-Dist: pluginify (>=1.0.0)
Requires-Dist: poetry-dynamic-versioning ; extra == "dev"
Requires-Dist: prettier ; extra == "lint"
Requires-Dist: psutil
Requires-Dist: pydantic (>=2.10.0)
Requires-Dist: pydata-sphinx-theme ; extra == "doc"
Requires-Dist: pygrib
Requires-Dist: pyhdf
Requires-Dist: pylint ; extra == "lint"
Requires-Dist: pyorbital
Requires-Dist: pypublicdecompwt
Requires-Dist: pyresample
Requires-Dist: pytest ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Requires-Dist: pytest-html ; extra == "test"
Requires-Dist: pytest-mock (>=3.14.0) ; extra == "test"
Requires-Dist: pytest-xdist ; extra == "test"
Requires-Dist: pyyaml
Requires-Dist: rasterio
Requires-Dist: referencing
Requires-Dist: rich (>=13.0)
Requires-Dist: rich-argparse ; extra == "doc"
Requires-Dist: rio-cogeo
Requires-Dist: satpy
Requires-Dist: scikit-image
Requires-Dist: scipy (>1.2)
Requires-Dist: setuptools (<70)
Requires-Dist: sphinx (<7.2) ; extra == "doc"
Requires-Dist: sphinx-argparse ; extra == "doc"
Requires-Dist: sphinx-design ; extra == "doc"
Requires-Dist: sphinxcontrib-autoprogram ; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid ; extra == "doc"
Requires-Dist: sphinxcontrib-typer ; extra == "doc"
Requires-Dist: tabulate
Requires-Dist: tqdm
Requires-Dist: xarray (>=2025.3.1)
Project-URL: Repository, https://github.com/NRLMMD-GEOIPS/geoips
Description-Content-Type: text/markdown

GeoIPS Base Package
====================

[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://nrlmmd-geoips.github.io/geoips/)
[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12-blue.svg)](https://www.python.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

The GeoIPS Base Package provides a Python 3 based architecture supporting a wide variety of
satellite and weather data processing. Processing is driven by composable **plugins** —
readers, algorithms, colormappers, output formatters, and more — orchestrated through
[Order-Based Processing (OBP)](https://nrlmmd-geoips.github.io/geoips/concepts/functionality/order-based-processing/index.html).
The modular nature of the GeoIPS base infrastructure also allows plug-and-play capability
for user-specified custom functionality.

GeoIPS is jointly developed and maintained by the Cooperative Institute for
Research in the Atmosphere (CIRA) at Colorado State University and the Naval
Research Laboratory (NRL) Marine Meteorology Division.

Full documentation is available at
[nrlmmd-geoips.github.io/geoips](https://nrlmmd-geoips.github.io/geoips/).

Installation
------------

GeoIPS supports Python 3.11 and 3.12. Install with whichever tool you prefer:

**pip**

```bash
pip install geoips
```

**uv**

```bash
uv pip install geoips
```

**nix**

The repository ships a flake with a ready-to-use development shell (Python 3.12
plus the native libraries the scientific stack needs). Clone the repo and run:

```bash
nix develop
```

This drops you into a shell with GeoIPS installed. To use it without cloning:

```bash
nix develop github:NRLMMD-GEOIPS/geoips
```

After installing, verify the CLI is available:

```bash
geoips --help
```

For the fully supported, exhaustive installation — including a complete conda
environment with all optional dependencies — see the installation guide
([linux](./docs/source/getting-started/installing/linux_with_conda.rst),
[mac](./docs/source/getting-started/installing/mac_with_conda.rst),
[windows](./docs/source/getting-started/installing/windows_with_conda.rst)).
The quick installs above are a more basic, pip-based path intended for "expert" users.

Creating your own GeoIPS Plugin
-------------------------------

See the instructions to
[set up a new plugin](./docs/source/tutorials/setting-up-for-plugin-development.rst)
if you are interested in creating your own functionality using the GeoIPS
infrastructure, then follow the
[extending-with-plugins tutorials](./docs/source/tutorials/extending-with-plugins/index.rst).

Contributing
-------------
Are you interested in
1. Notifying the geoips team of bugs?
2. Submitting a fix to a known bug?
3. Contributing new functionality to the main geoips code base?
4. Creating your own geoips-compatible plugin?

We welcome all feedback and contributions!

Please review our
[contributing guide](./docs/source/contribute/index.rst)
for more information.

Contact
----------
Please contact geoips@nrlmry.navy.mil with any questions comments or concerns, and
for additional information about our regular user/developer meetings, Slack channel,
and other forms of communication.

Slack Channel
----------
For those interested in contributing to GeoIPS, have informal feature requests, or
have lingering questions not answered by the documentation, feel free to join our
[Slack Channel](https://geoips.slack.com/). If you are not permitted to join, email
geoips@nrlmry.navy.mil to request access.

Acknowledgments and Citations
------------------------------
Please display the following acknowledgment within all published research using this software:

    "This work uses the GeoIPS(R) software package written and
    developed by the Cooperative Institute for Research in the Atmosphere
    (CIRA) at Colorado State University and the Naval Research Laboratory
    Marine Meteorology Division.
    https://github.com/NRLMMD-GEOIPS/"

See [GeoIPS LICENSE](https://github.com/NRLMMD-GEOIPS/geoips/blob/main/LICENSE) for
more information.

* https://github.com/NRLMMD-GEOIPS/geoips/blob/main/LICENSE

If using imagery generated using the GeoIPS software package, please include the following acknowledgment:

    "This work includes imagery generated using the GeoIPS(R) software package,
    written and developed by the Cooperative Institute for Research in the
    Atmosphere (CIRA) at Colorado State University and the Naval Research
    Laboratory Marine Meteorology Division.
    https://github.com/NRLMMD-GEOIPS/"

If using imagery downloaded from the www.nrlmry.navy.mil websites, please include the following acknowledgment:

    "This work includes imagery generated by the Naval Research Laboratory
    Marine Meteorology Division"

Documentation
------------------------------
The documentation can be found at:

https://nrlmmd-geoips.github.io/geoips/ 

