Welcome to PyGNOME’s documentation!

PyGNOME is general Lagrangian Element (particle tracking) code written primarily in Python, with some bindings to C++ code for certain functionality. It is the core engine of the General NOAA Operational Modeling Environment (GNOME) Suite of tools.

This document provides guidance on using the PyGNOME package to solve problems, as well as details about its internals that can be used to extend PyGNOME’s functionality.

The PyGNOME source code can be found on GitHub Here:

https://github.com/NOAA-ORR-ERD/PyGnome

And this document should be published here:

https://gnome.orr.noaa.gov/doc/pygnome/index.html

Contents:

• Introduction
  • History
• Installing
  • Installing from Source:
• PyGNOME Structure
  • Primary Base Classes in gnome
• Scripting PyGNOME
  • Overview
  • The Model
  • Maps
  • Spills
  • Environment Objects
  • Movers
  • Weatherers
  • Outputters
  • Examples
• Extending / Customizing PyGNOME
  • Extending / Customizing PyGNOME
  • The logging system
  • Notes on serialization / deserialization
  • Indices and tables
• GNOME File Formats
  • Maps
  • Wind
  • Gridded NetCDF formats
  • NOAA specific file formats for currents
  • Scaling Current Patterns
  • GNOME Output file formats
  • Legacy Formats
• API Reference
  • gnome
• Units used in GNOME / PyGNOME
• GNOME Tech Notes
  • Error messages and fixes
  • The role of mass in GNOME
  • Stokes Drift
  • Diffusion
  • Evaporation

Indices and tables

• Index

• Module Index

• Search Page