SCHISM

Grids

rompy.schism.grid.SCHISMGrid

SCHISM grid in geographic space.

Data

Supporting objects for SCHISM data files.jects

Main objects

rompy.schism.data.SCHISMDataSflux
rompy.schism.data.SCHISMDataWave	This class is used to write wave spectral boundary data.
rompy.schism.data.SCHISMDataBoundaryConditions	This class configures all boundary conditions for SCHISM including tidal, ocean, river, and nested model boundaries.
rompy.schism.data.HotstartConfig	Configuration for generating SCHISM hotstart files.
rompy.schism.data.SCHISMData	This class is used to gather all required input forcing for SCHISM

Boundary Conditions

The boundary conditions module provides a unified interface for configuring all types of SCHISM boundary conditions including tidal, ocean, river, and nested model boundaries.

• SCHISM Boundary Conditions
  • Overview
  • Key Classes
  • Boundary Type Enums
  • Factory Functions
  • Usage Examples
  • Boundary Types
  • Data Sources
  • Configuration Files
  • Benefits of the New System
  • Advanced Features
  • See Also

Hotstart Configuration

The hotstart system provides integrated initial condition file generation, allowing you to create hotstart.nc files from the same ocean data sources used for boundary conditions.

• SCHISM Hotstart Configuration
  • Overview
  • Key Features
  • Architecture
  • HotstartConfig Class
  • Usage Examples
  • Python API Usage
  • Integration with Factory Functions
  • Generated Files
  • Data Source Requirements
  • Error Handling
  • Best Practices
  • Troubleshooting
  • Migration from Legacy Hotstart
  • See Also

Backend Framework

The backend framework provides unified execution of SCHISM simulations using Docker containers with automatic image building and comprehensive testing capabilities.

• SCHISM Backend Framework
  • Overview
  • Key Features
  • Architecture
  • Boundary Conditions Testing
  • Docker Image Management
  • Testing Framework
  • Configuration Examples
  • Advanced Usage
  • Error Handling
  • Migration Guide
  • Best Practices
  • Troubleshooting
  • See Also
• SCHISM Backend Framework Tutorial
  • Getting Started
  • Basic Tutorial
  • Intermediate Tutorial
  • Advanced Tutorial
  • Production Usage
  • Troubleshooting
  • Best Practices Summary
  • Next Steps

rompy.schism.data.SCHISMDataBoundaryConditions	This class configures all boundary conditions for SCHISM including tidal, ocean, river, and nested model boundaries.
rompy.schism.data.BoundarySetupWithSource	Enhanced boundary setup that includes data sources.
rompy.schism.boundary_conditions.create_tidal_only_boundary_config	Create a configuration where all open boundaries are treated as tidal boundaries.
rompy.schism.boundary_conditions.create_hybrid_boundary_config	Create a configuration for hybrid harmonic + external data boundaries.
rompy.schism.boundary_conditions.create_river_boundary_config	Create a configuration with a designated river boundary and optional tidal boundaries.
rompy.schism.boundary_conditions.create_nested_boundary_config	Create a configuration for nested model boundaries with external data.

Config Minimal

This object has been implemented to meet the initial operational requirements of CSIRO. It is likely that this will be superceded by the full implementation.

rompy.schism.config.SchismCSIROConfig

Full Namelist Implementation

This object implements a set of models for each namelist and assembles a config object using this group of models. This is curently only partly implemented.

PARAM

rompy.schism.namelists.param.Core
rompy.schism.namelists.param.Opt
rompy.schism.namelists.param.Schout
rompy.schism.namelists.param.Vertical
rompy.schism.namelists.param.Param

ICE

rompy.schism.namelists.ice.Ice_in
rompy.schism.namelists.ice.Ice

MICE

rompy.schism.namelists.mice.Mice_in
rompy.schism.namelists.mice.Mice

ICM

rompy.schism.namelists.icm.Bag
rompy.schism.namelists.icm.Core
rompy.schism.namelists.icm.Ero
rompy.schism.namelists.icm.Marco
rompy.schism.namelists.icm.Ph_icm
rompy.schism.namelists.icm.Poc
rompy.schism.namelists.icm.Sav
rompy.schism.namelists.icm.Sfm
rompy.schism.namelists.icm.Silica
rompy.schism.namelists.icm.Stem
rompy.schism.namelists.icm.Veg
rompy.schism.namelists.icm.Zb
rompy.schism.namelists.icm.Icm

SEDIMENT

rompy.schism.namelists.sediment.Sed_opt
rompy.schism.namelists.sediment.Sed_core
rompy.schism.namelists.sediment.Sediment

COSINE

rompy.schism.namelists.cosine.Core
rompy.schism.namelists.cosine.Marco
rompy.schism.namelists.cosine.Misc
rompy.schism.namelists.cosine.Cosine

WWMINPUT

rompy.schism.namelists.wwminput.Coupl
rompy.schism.namelists.wwminput.Engs
rompy.schism.namelists.wwminput.Grid
rompy.schism.namelists.wwminput.History
rompy.schism.namelists.wwminput.Hotfile
rompy.schism.namelists.wwminput.Init
rompy.schism.namelists.wwminput.Nesting	Empty class to fill empty nesting namelist
rompy.schism.namelists.wwminput.Nums
rompy.schism.namelists.wwminput.Petscoptions
rompy.schism.namelists.wwminput.Proc
rompy.schism.namelists.wwminput.Station
rompy.schism.namelists.wwminput.Wwminput

NML

This is the full namelist object that is the container for all the other namelist objects.

rompy.schism.namelists.NML

Config Object

rompy.schism.config.SCHISMConfig