Installation¶
Prerequisites¶
- Python 3.12 or newer
- pip (Python package manager)
- (Optional) conda for environment management
Clone the Repository¶
git clone https://github.com/slaclab/trace.git
Create and Activate a Virtual Environment (Recommended)¶
Using venv:
python3 -m venv .venv
source .venv/bin/activate
Or using conda:
conda env create -f environment.yml
conda activate trace
Install Dependencies¶
If using pip:
pip install -r requirements.txt
Or with conda (if you created the environment above, dependencies are already installed):
conda env update -f environment.yml
Environment Setup¶
Trace references a couple of environment variables that can be used for configuring some interactions.
Below is a table describing the environment variables that need to be set.
| Variable | What is it used for? |
|---|---|
| PYDM_ARCHIVER_URL | The base URL for the Archiver Appliance Data Plugin |
| SWAPPS_TRACE_ELOG_API_URL | The base URL for the E-Log API |
| SWAPPS_TRACE_ELOG_API_KEY | Your API key for authenticating with the E-Log system |
Running Trace¶
The main startup file for trace is located at trace/main.py.
Trace can be launched using PyDM, and users can pass in additional arguments and macros.
pydm trace/main.py