To see which systems C-Star has been tested on so far, see Supported Systems.
Installation
Install with conda (recommended)
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.
2 maintainers
Release files for cstar-ocean 0.15.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cstar_ocean-0.15.1.tar.gz | 3.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cstar_ocean-0.15.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.8 MB
Release files / cstar_ocean-0.15.1.tar.gz
| Download URL | cstar_ocean-0.15.1.tar.gz |
|---|---|
| Size | 3.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a39f42caca94175037c9ca4a014ed7b5ac9e39a64a1f6e5de522212ab1015163
|
|
BLAKE2b-256 checksum How to use checksums |
ac80f46cd270db59fa220bb34e5916d6311d2cb7e7e2d8a6738ba229a6e0419a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency logRelease files / cstar_ocean-0.15.1-py3-none-any.whl
| Download URL | cstar_ocean-0.15.1-py3-none-any.whl |
|---|---|
| Size | 1.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d79a02a65cc83698643065cc622ad77b3cdd9550ca7829c2edc2fc6fd684dcaf
|
|
BLAKE2b-256 checksum How to use checksums |
8964f77e2e83099a9c8097898a766a346ad6787d8f915d575dd8e57858a6c68e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency log
