Tutorials for users

Tutorials for users#

All tutorials assume that you already have successfully installed pyCIF.

Tip

Running examples with Docker

All YAML examples listed in Examples of configuration files are run automatically by the CI pipeline. To reproduce them locally:

  1. Pull the pyCIF Docker image (see the installation guide).

  2. Download the reference test data (the CI pipeline fetches it via gitlab-ci.yml).

  3. Pick a YAML file from Examples of configuration files, adjust rootdir and outdir to match your paths, and run:

    python -m pycif path/to/your_config.yml

The CHIMERE ready-made tutorial walks through this workflow step by step.

Tutorials by model#

Tutorials by theme#