GeoIPS Base Package

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). 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.

Installation

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

pip

pip install geoips

uv

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:

nix develop

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

nix develop github:NRLMMD-GEOIPS/geoips

After installing, verify the CLI is available:

geoips --help

For the fully supported, exhaustive installation — including a complete conda environment with all optional dependencies — see the installation guide (linux, mac, windows). 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 if you are interested in creating your own functionality using the GeoIPS infrastructure, then follow the extending-with-plugins tutorials.

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 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. 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 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/