SalishSeaCast Tools Documentation
This is the documentation for the SalishSeaCast project tools collection. The docs describe a collection of tools for working with the SalishSeaCast NEMO model, its results, and associated data. There is a companion collection of project documentation.
The tools
repo contains several Python packages:
SalishSeaToolsPackage
- a collection of Python modules that facilitate code reuse across the SalishSeaCast projectSOGTools
- Python functions for working with the output of the SOG 1-D model
Also documented here are:
Notes are how the Python packages in the repo are developed and maintained
How we create netCDF4 files and the metadata conventions that we use in them
How to build and use the REBUILD_NEMO that we use to combine per-processor results files from NEMO-3.4 runs
Some of the Jupyter Notebooks and Python scripts that we use to prepare bathymetry and initial conditions & forcing files for NEMO runs
There is also some Legacy Documentation from our early days of learning to configure and run NEMO.
Contents:
- Changes That Break Backward Compatibility
- SalishSeaTools Package
SOGTools
Package- netCDF4 Files Creation and Conventions
- Building ERDDAP Datasets
- Visualisation of NEMO/GEM/Observations using XArray
- Bathymetry Notebooks and Tools
- Initial Conditions and Forcing Notebooks and Tools
- Live Ocean Boundary Conditions Tools
- Python Packages Development and Maintenance
- NEMOGCM Tools
- Legacy Documentation
Licenses
Unless otherwise specified, the SalishSeaCast tools and documentation are copyright 2013 – present by the SalishSeaCast Project Contributors and The University of British Columbia.
They are licensed under the Apache License, Version 2.0. https://www.apache.org/licenses/LICENSE-2.0 Please see the LICENSE file for details of the license.
The salishsea_tools.namelist
and salishsea_tools.tests.test_namelist
modules are based on https://gist.github.com/krischer/4943658.
They are copyright 2013 by Lion Krischer <krischer@geophysik.uni-muenchen.de> and are
licensed under the GNU Lesser General Public License, Version 3 (https://www.gnu.org/copyleft/lesser.html).