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.

Python API Developer Guides

This page contains older tutorials and guides for using individual classes within C-Star to manually construct and run simulations and blueprints. This is no longer the primary user interface, but the content may still be useful for developers.

Tutorials

• Building a Simulation and exporting it as a blueprint
• Importing and running a Simulation from a blueprint
• Restarting and continuing a Simulation

How-to Guides

• Working with the AdditionalCode class
• Working with the InputDataset class
• Working with the ExternalCodeBase class
• Tracking runs executed locally
• Tracking runs executed as jobs on HPC systems