C-Star Forge has moved into C-Star

This repository is retired. C-Star Forge -- the wizard, resolver, catalog, executor and cstar forge CLI for generating regional ROMS-MARBL domains -- ships inside cstar-ocean from version 0.15.0. Development, issues and pull requests continue there. Documentation: https://c-star.readthedocs.io/en/latest/forge/index.html.

C-Star Forge logo

Installing

There is nothing separate to install any more:

conda install -c conda-forge cstar-ocean   # or: pip install cstar-ocean
cstar forge --help

The cstar-forge package on PyPI and conda-forge (0.9.x) is a compatibility shim that depends on cstar-ocean >= 0.15.0 and forwards the old cstar_forge.* import paths to their new homes with a DeprecationWarning. Nothing in it does any work. Once your imports are updated, pip uninstall cstar-forge (or conda remove cstar-forge).

What changed for users

Before (cstar-forge 0.8.x)	Now (cstar-ocean 0.15+)
`cstar forge run`, `cstar forge wizard`, `cstar forge show-paths`, `cstar forge copy-notebook`	unchanged, built into `cstar`
`cstar forge register-kernel`	`cstar env register-kernel`
`python -m cstar_forge.run <blueprint>`	`cstar forge run <blueprint>`
`CSTAR_FORGE_CATALOG`	`CSTAR_CATALOG`
writable catalog at `~/cstar-forge-data/catalog`	`~/cstar/catalog` (a catalog at the old location is not read; forge logs a hint)
`forge_version` stamp in forge blueprints	`cstar_version` (old files still load)

Source-data cache, working-directory relocation onto HPC scratch, and every generated file location are unchanged.

What changed for Python imports

Before	Now
`cstar_forge.forge.forge_blueprint`	`cstar.applications.forge.blueprint`
`cstar_forge.forge.forge_blueprint_engine`	`cstar.applications.forge.engine`
`cstar_forge.forge.executor`, `.settings`, `.input_data`, `.source_datasets`, `.namelist_model`, ...	`cstar.applications.forge.<same name>`
`cstar_forge.forge_blueprint_resolve`	`cstar.applications.forge.resolve`
`cstar_forge.models`, `cstar_forge.config`	`cstar.applications.forge.models`, `.config`
`cstar_forge.run`	`cstar.applications.forge.runtime`
`cstar_forge.domain_catalog`	`cstar.catalog.domain_catalog`
`cstar_forge.forge_blueprint_wizard`, `cstar_forge.ui.*`	`cstar.wizard.wizard`, `cstar.wizard.ui.*`
`cstar_forge.cli`	`cstar.cli.forge`
`cstar_forge.register_kernel`	`cstar.cli.environment.register_kernel`

The full table is cstar_forge.MODULE_ALIASES in this package.

History

The last standalone version of the code (0.8.2, plus the pre-move cleanup) is kept on the legacy-0.8 branch of this repository for reference. The complete cstar-forge commit history was imported into C-Star (C-Star #699), so git blame and git log --follow on the relocated files continue to work there. Release notes for the standalone package (0.1.0 through 0.8.2) are kept in docs/releases.md and under Releases in the C-Star docs.

Metadata

Release files for cstar-forge 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cstar-forge 0.9.0
File	Size	Uploaded
cstar_forge-0.9.0.tar.gz	1.3 MB	Sep 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for cstar-forge 0.9.0
File	Interpreter	ABI	Platform	Reset
cstar_forge-0.9.0-py3-none-any.whl 9.4 kB Sep 23, 2026	Python 3	none	any	Details

Total release size: 1.3 MB

Release files / cstar_forge-0.9.0.tar.gz

Download URL	cstar_forge-0.9.0.tar.gz
Size	1.3 MB
Tags	Source
SHA-256 checksum How to use checksums	`b0ed4982a3df3f858888c2c3f0e38dbe428da843d6eb328072d6c7f8ce04d021`
BLAKE2b-256 checksum How to use checksums	`9760df68929a216f5709c55ca52f83d1ab9e1e00d9da09619fbdc8246d088a54`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/CWorthy-ocean/cstar-forge
Publishing commit: github.com/CWorthy-ocean/cstar-forge/tree/88bf7f0119ac67d616dccdd6bda36bffb6c106cc

Workflow

Publishing configuration: github.com/CWorthy-ocean/cstar-forge/blob/88bf7f0119ac67d616dccdd6bda36bffb6c106cc/.github/workflows/pypipublish.yaml
Publishing logs: github.com/CWorthy-ocean/cstar-forge/actions/runs/35922808033/attempts/1

Artifact

Subject: cstar_forge-0.9.0.tar.gz
SHA-256 checksum: b0ed4982a3df3f858888c2c3f0e38dbe428da843d6eb328072d6c7f8ce04d021 Verifying attestations

Release files / cstar_forge-0.9.0-py3-none-any.whl

Download URL	cstar_forge-0.9.0-py3-none-any.whl
Size	9.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1844a854fe0a4d5c22f92a8a2d6d719aed183f74af053d58ee7e92fe930ee4bf`
BLAKE2b-256 checksum How to use checksums	`95495a9d9bcf5021abdafde4a4a09e3f864d6223675baf9d2e15cf1cc304cd83`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/CWorthy-ocean/cstar-forge
Publishing commit: github.com/CWorthy-ocean/cstar-forge/tree/88bf7f0119ac67d616dccdd6bda36bffb6c106cc

Workflow

Publishing configuration: github.com/CWorthy-ocean/cstar-forge/blob/88bf7f0119ac67d616dccdd6bda36bffb6c106cc/.github/workflows/pypipublish.yaml
Publishing logs: github.com/CWorthy-ocean/cstar-forge/actions/runs/35922808033/attempts/1

Artifact

Subject: cstar_forge-0.9.0-py3-none-any.whl
SHA-256 checksum: 1844a854fe0a4d5c22f92a8a2d6d719aed183f74af053d58ee7e92fe930ee4bf Verifying attestations