Skip to content

Run Template Orchestrator 1.2.0

This repository contains the new Run Template Orchestrator used in the latest Cosmotech Solutions

Installation

You need to add the orchestrator to the environment you want to use it on.

The following guide will suppose you have a CosmoTech Project called MyProject which is in the folder ~/MyProject

It will also suppose you have a build version of the CosmoTech SDK in the folder ~/Cosmotech/Studio

Create a virtual environment and add dependencies (in bash)

# First move to your project folder
cd ~/MyProject
# Next create and activate a venv (here .venv)
python -m venv .venv
source .venv/bin/activate
# Finally install the dependencies for your project (they should be in code/requirements.txt)
pip install -r code/requirements.txt
To add python wrappers of the Cosmo Tech simulators you need to update your PYTHONPATH before running commands

# Update your python path with the bindings from the sdk
export PYTHONPATH=$PYTHONPATH:~/Cosmotech/Studio/lib/python/site-packages
# Add the local wrappers for your solution to the python path
export PYTHONPATH=$PYTHONPATH:~/MyProject/Generated/Build/Wrapping:~/MyProject/Generated/Build/Lib
# Now further commands will have the PYTHONPATH correctly set
csm-orc run ...

If you use the Cosmotech CLI csmcli you can replace the use of the PYTHONPATH environment variable by calls to csm exec

# prepending your command by using csm exec will fully set your environment with complementary variables
csm exec csm-orc run ...

After all those commands you environment should be ready for a test, but first let's install the repository

Install the orchestrator from git sources

pip install git+ssh://git@github.com/Cosmo-Tech/run-orchestrator.git

Install the orchestrator from local sources

git clone ssh://git@github.com/Cosmo-Tech/run-orchestrator.git
pip install ./run-orchestrator

Install using pip

pip install cosmotech-run-orchestrator

After installation a few commands are made available, documentation for each is available on the commands documentation page

Autocompletion

Run the following command

_CSM_ORC_COMPLETE=bash_source csm-orc > ~/.csm-orc-complete.bash
then add the following line at the end of your .bashrc file
. ~/.csm-orc-complete.bash