In this guide, we will walk you through setting up and running SCHISM simulations using the Inductiva API.

We will cover:

  • Configuring SCHISM simulations using the Inductiva API.

  • Example code to help you get started with simulations.

  • Available benchmarks to test SCHISM’s capabilities in both 2D and 3D environments.

SCHISM#

SCHISM is an open-source 3D baroclinic circulation model designed to simulate hydrodynamics across creek-lake-river-estuary-shelf-ocean scales. It excels at modeling complex water circulation systems with varying salinity and temperature, making it a powerful tool for coastal, estuarine, and oceanographic research.

Example Code#

Below is an example of running a SCHISM simulation via the Inductiva API:

"""SCHISM example."""
import inductiva

# Instantiate machine group
machine_group = inductiva.resources.MachineGroup("c2-standard-4")
machine_group.start()

# Set simulation input directory
input_dir = inductiva.utils.files.download_from_url(
    "https://storage.googleapis.com/inductiva-api-demo-files/"
    "schism-input-example.zip", True)

# Initialize the Simulator
schism = inductiva.simulators.SCHISM()

# Run simulation with config files in the input directory
task = schism.run(input_dir=input_dir,
                  n_vcpus=3,
                  num_scribes=2,
                  on=machine_group)

task.wait()
task.download_outputs()

machine_group.terminate()

Available Benchmarks for SCHISM#

The following benchmarks are available to test SCHISM’s performance: