GNOME (General NOAA Operational Modeling Environment) is a modeling tool developed by the National Oceanic and Atmospheric Administration (NOAA), Office of Response and Restoration (ORR), Emergency Response Division.
It is designed to support oil and other hazardous material spills in the coastal environment, and is also a full featured, flexible particle tracking system, that can be used for other oceanographic transport applications, such as fish larvae, marine debris, etc.
PyGNOME is a python package that encapsulates GNOME's functionality.
This code is under active development
- It should not be considered an officially endorsed NOAA product.
- Output produced by this code should not be considered endorsed by NOAA.
We have put some effort into making this package reasonably easy, or at least possible, to install in a number of ways on a few different computing platforms:
- OS-X
- Windows
- Linux (tested on CentOS 7)
At this time, it must be compiled from the source code.
The "tricky" part is installing the dependencies: details in the following:
The conda package manager is built primarily for scientific, engineering, and math applications it is the easiest way to get set up to use PyGNOME, and it is used in our development and testing process.
If you don't want to / can't use conda -- here are some notes on that:
Move to the repository directory and activate the gnome conda environment with:
(base) conda activate gnome
Delete py3buildenv_.txt if re-compiling code after making software changes. The text file py3buildenv_.txt is used to cache software versions to avoid repitious prompts but will cause path problems if changes have been made and needs to be deleted to avoid these erroneous path defs.
Copy python Py3Env.py to an untracked file that defines local setup, e.g. python Py3Env_RDM.py, and edit places to point to the right directory on your local system:
places = [r"put-your-VisualStudio-vcvars64.bat-directory-path-here"]
This file can remain untracked in version control because it is unique to each user and easily reproducible from the tracked file Py3Env.py that will be updated with future advancements. Once this path is corrected to local path, run the script in gnome environment:
(base) conda activate gnome
(gnome) python Py3Env_RDM.py
A command terminal cmd.exe prompt will open. Change directories and run setup.py
(gnome) cd py_gnome
(gnome) python setup.py develop
After many, many messages, you will see something like:
Installed c:usersrachael.muellerprojectspygnomepy_gnome
Processing dependencies for pyGnome==1.1.7
Finished processing dependencies for pyGnome==1.1.7
Scripting is the most featurefull way to access PyGNOME's capabilities. However we have developed a system that allows a user to create and run PyGNOME models from a web browser.
There is a publicly available instance of WebGNOME at:
If you want to run your own instance of WebGNOME, the code is in the following projects:
- WebGnomeAPI: A web server that implements the PyGNOME interface
- WebGnomeClient: A Web application for setting up and running PyGNOME models
Fair Warning:
The WebGNOME system is under active development, and by its very nature does not expose the full capabilities of PyGNOME.