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.
Welcome to the C-Star Documentation!#
C-Star is an open-source ocean modeling system developed by a team of ocean/biogeochemical modelers and scientific software engineers at [C]Worthy. It currently runs ucla-roms and MARBL, and is designed to support Monitoring, Reporting, and Verification (MRV) for research and commercial ocean-based Carbon Dioxide Removal (CDR) projects. C-Star aims to provide an accessible, common, framework for creating, sharing, and reproducing ocean biogeochemical simulations.
We are designing and building C-Star with these high-level principles in mind:
Scientific Integrity: The C-Star modeling system utilizes trusted biogeochemical ocean models that have been developed in the public domain through decades of scientific R&D. Community involvement and iteration ensures that we are tracking the best-available science.
Transparency and Accessibility of our code: Facilitates broad trust and adoption by both academic and commercial actors.
Reproducible and auditable: Modeling simulations used to underpin carbon removal claims must be shareable and reproducible by a range of users.
Ease of use: Ensures consistent application by diverse user groups including the commercial sector.
Standardization: Ensures a consistent level of quality across CDR projects.
A key strength of C-Star lies in its ability to run regional ocean simulations using a “blueprint” that consolidates all the necessary data to define a model setup. This enables the creation of curated databases containing both scientifically validated and research-grade blueprints. These blueprints offer users the flexibility to easily reproduce simulations, making the modeling process more accessible and consistent.
Getting Started
Terminology and Concepts
Laptop-Runnable Examples
User Guide
Deployment
Reference
For Developers