Quickstart

The code can be used locally, in a Docker image, or in the calculation engine. See Installation for build and Docker setup. For the calculation engine, see Usage with the MUSES Calculation Engine and the Tutorial.

Running the Module

  1. Set Up Configuration File: Create the config.yaml file using:

    python3 create_config.py --option1 value1 --option2 value2
    

    For available options, refer to the OpenAPI Specification.

  2. Validate Configuration File: Validate and fill in missing variables with default values:

    python3 validate_config.py
    
  3. Run the C++ Code: Run the executable with:

    ./synthesis
    

    If using custom paths, adjust the commands as needed.

  4. Postprocessing: Convert outputs to HDF5 format or other formats:

    python3 postprocess.py