Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

Simulation API

Simulation

cstar.simulation.Simulation(name, directory, ...)	An abstract base class representing a C-Star simulation.
cstar.roms.ROMSSimulation(name, directory, ...)	A specialized Simulation subclass for configuring and running ROMS (Regional Ocean Modeling System) simulations.

External Codebases

cstar.base.external_codebase.ExternalCodeBase([...])	Abstract base class to manage external non-python dependencies of C-Star.
cstar.roms.external_codebase.ROMSExternalCodeBase([...])	An implementation of the ExternalCodeBase class for the UCLA Regional Ocean Modeling System.
cstar.marbl.external_codebase.MARBLExternalCodeBase([...])	An implementation of the ExternalCodeBase class for the Marine Biogeochemistry Library.

Additional Code

cstar.base.additional_code.AdditionalCode(...)

Additional code contributing to a model simulation.

Input Datasets

cstar.base.input_dataset.InputDataset(location)	Describes spatiotemporal data needed to run a unique instance of a model simulation.
cstar.roms.input_dataset.ROMSInputDataset(...)
cstar.roms.input_dataset.ROMSModelGrid(location)	An implementation of the ROMSInputDataset class for model grid files.
cstar.roms.input_dataset.ROMSInitialConditions(...)	An implementation of the ROMSInputDataset class for model initial condition files.
cstar.roms.input_dataset.ROMSTidalForcing(...)	An implementation of the ROMSInputDataset class for model tidal forcing files.
cstar.roms.input_dataset.ROMSRiverForcing(...)	An implementation of the ROMSInputDataset class for river forcing files.
cstar.roms.input_dataset.ROMSBoundaryForcing(...)	An implementation of the ROMSInputDataset class for model boundary condition files.
cstar.roms.input_dataset.ROMSSurfaceForcing(...)	An implementation of the ROMSInputDataset class for model surface forcing files.
cstar.roms.input_dataset.ROMSForcingCorrections(...)	ROMS forcing correction file, such as SW correction or restoring fields.
cstar.roms.runtime_settings.ROMSRuntimeSettings(*, ...)	Container for reading, manipulating, and writing ROMS .in runtime configuration files.

Discretization

cstar.base.discretization.Discretization(...)

Holds discretization information about a Component.

Scheduler Job

cstar.execution.handler.ExecutionHandler()	Abstract base class for managing the execution of a task or process.
cstar.execution.local_process.LocalProcess(...)	Execution handler for managing and monitoring local subprocesses.
cstar.execution.scheduler_job.SchedulerJob(...)	Abstract base class for representing a job submitted to a scheduler.
cstar.execution.scheduler_job.SlurmJob(...)	Represents a job submitted to the SLURM scheduler.
cstar.execution.scheduler_job.PBSJob(...[, ...])	Represents a job submitted to the PBS (Portable Batch System) scheduler.

io

cstar.io.source_data.SourceData(location[, ...])	Class for obtaining information about and acting on a source of data
cstar.io.source_data.SourceDataCollection([...])	Single class to hold a collection of related SourceData instances
cstar.io.staged_data.StagedData(source, path)	Class to track locally staged data (files, repositories, etc.)
cstar.io.staged_data.StagedDataCollection(items)	A class to hold a collection of related SourceData instances.
cstar.io.stager.Stager(source)	Class to handle the staging of data on the local filesystem for access by C-Star.
cstar.io.retriever.Retriever(source)	Class to handle retrieval of data for access by C-Star

System

cstar.system.manager.CStarSystemManager()	Manage system-specific configuration and resources.
cstar.system.scheduler.Scheduler(queues, ...)	Abstract base class for representing a job scheduler.
cstar.system.environment.CStarEnvironment(...)	Encapsulates the configuration and management of a computing environment for a specific system, including compilers, job schedulers, memory, and core settings.