Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

C-Star

A python package for setting up and running ocean model simulations, with a particular focus on marine carbon dioxide removal applications.
https://github.com/cworthy-ocean/c-star

Category: Emissions
Sub Category: Carbon Capture

Last synced: about 15 hours ago
JSON representation

Repository metadata

C-Star is a python package for setting up and running ocean model simulations, with a particular focus on marine carbon dioxide removal (mCDR) applications.

README.md

codecov
Documentation Status
Conda Version

[!Warning]
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 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 Q1 2026.

To see which systems C-Star has been tested on so far, see Supported Systems.

Installation

C-Star is published on conda-forge as cstar-ocean.

On a laptop or workstation, install cstar-ocean-standalone, which bundles a complete build toolchain (compilers, MPI, netCDF-Fortran, PnetCDF, CMake) so ROMS can be compiled with no system dependencies:

conda create -n cstar-env -c conda-forge cstar-ocean-standalone

On a supported HPC system (toolchain provided by Environment Modules), install just the package:

conda create -n cstar-env -c conda-forge cstar-ocean

Then conda activate cstar-env and you're ready to go.

Installation from source (developers)

To obtain the latest development version, clone this repository:

git clone https://github.com/CWorthy-ocean/C-Star.git
cd C-Star

Next, install one of the following conda environments, depending on whether you are working on a supported HPC system (environment management by Linux Environment Modules) or a generic machine like a laptop (environment-laptop.yml bundles the same conda-forge toolchain that cstar-ocean-standalone provides, for developers who prefer an editable install):

conda env create -f environment-hpc.yml  # conda environment for supported HPC system
# conda env create -f environment-laptop.yml  # conda environment for generic machine

Activate the conda environment:

conda activate cstar-env

Finally, install C-Star in the same environment:

pip install -e .

Run the tests

Before running the tests, you can activate the conda environment created in the previous section:

conda activate cstar-env

Check the installation of C-Star has worked by running the test suite

cd C-Star
pytest

Getting Started

To learn how to use C-Star, check out the documentation.

Feedback and contributions

If you find a bug, have a feature suggestion, or any other kind of feedback, please start a Discussion.

We also accept contributions in the form of Pull Requests.

License

C-Star is openly available for use and permissively licenced under Apache 2.0.

Copyright 2025 [C]Worthy LLC.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 792
Total Committers: 14
Avg Commits per committer: 56.571
Development Distribution Score (DDS): 0.616

Commits in past year: 302
Committers in past year: 9
Avg Commits per committer in past year: 33.556
Development Distribution Score (DDS) in past year: 0.487

Name Email Commits
Dafydd Stephenson “****n@h****” 304
Christopher McBride 3****a 209
Scott Eilerman s****n@c****g 95
Dafydd d****n@h****m 77
Nora Loose n****e@g****m 53
TomNicholas t****m@c****g 31
Matt Long m****t@c****g 6
github-actions[bot] 4****] 6
Sam Maticka 4****a 4
Joseph Gaines 1****s 3
dependabot[bot] 4****] 1
Dafydd Stephenson d****d@l****v 1
Dafydd Stephenson d****d@d****u 1
Dafydd Stephenson d****d@d****u 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 129
Total pull requests: 354
Average time to close issues: 27 days
Average time to close pull requests: 5 days
Total issue authors: 7
Total pull request authors: 12
Average comments per issue: 1.01
Average comments per pull request: 1.03
Merged pull request: 260
Bot issues: 0
Bot pull requests: 5

Past year issues: 1
Past year pull requests: 154
Past year average time to close issues: N/A
Past year average time to close pull requests: 4 days
Past year issue authors: 1
Past year pull request authors: 5
Past year average comments per issue: 1.0
Past year average comments per pull request: 1.1
Past year merged pull request: 123
Past year bot issues: 0
Past year bot pull requests: 5

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cworthy-ocean/c-star

Top Issue Authors

  • dafyddstephenson (51)
  • TomNicholas (50)
  • NoraLoose (16)
  • ScottEilerman (8)
  • ubbu36 (2)
  • matt-long (1)
  • saadqayum (1)

Top Pull Request Authors

  • ankona (139)
  • dafyddstephenson (99)
  • ScottEilerman (54)
  • NoraLoose (33)
  • TomNicholas (18)
  • github-actions[bot] (5)
  • matt-long (1)
  • ekemper (1)
  • sdbachman (1)
  • smaticka (1)
  • JoeGaines (1)
  • nf-core-bot (1)

Top Issue Labels

  • jira-story (22)
  • bug (14)
  • enhancement (12)
  • documentation (8)
  • internals (8)
  • testing (6)
  • design (5)
  • ROMS (4)
  • roms-tools (4)
  • dependencies (3)
  • CI (3)
  • user testing (2)
  • packaging (2)
  • dependency (1)
  • typing (1)
  • help wanted (1)
  • good first issue (1)

Top Pull Request Labels

  • internals (14)
  • CI (13)
  • enhancement (8)
  • testing (8)
  • documentation (7)
  • bug (4)
  • packaging (3)
  • releases (2)
  • design (1)
  • roms-tools (1)
  • jira-story (1)
  • dependencies (1)
  • user testing (1)

Package metadata

pypi.org: cstar-ocean

Computational systems for tracking ocean carbon

  • Homepage:
  • Documentation: https://cstar-ocean.readthedocs.io/
  • Licenses: Apache-2.0
  • Latest release: 0.11.2 (published 2 days ago)
  • Last Synced: 2026-08-28T01:56:19.354Z (1 day ago)
  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 909 Last month
  • Rankings:
    • Dependent packages count: 9.91%
    • Average: 32.843%
    • Dependent repos count: 55.777%
  • Maintainers (2)

Dependencies

.github/workflows/finalize_release_notes.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/sphinx.yaml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v2 composite
.github/workflows/close_jira_ticket.yaml actions
  • actions/github-script v6 composite
.github/workflows/integration_tests.yaml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4.0.1 composite
  • mamba-org/setup-micromamba v2 composite
.github/workflows/pre-commit.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pre-commit/action v3.0.1 composite
.github/workflows/unit_tests.yaml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4.0.1 composite
  • mamba-org/setup-micromamba v2 composite
.github/workflows/update_release_notes.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/pypipublish.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish v1.13.0 composite
.github/workflows/open_jira_ticket.yaml actions
  • actions/checkout v2 composite
pyproject.toml pypi

Score: 13.324801237783108