Table of Contents |
---|
Introduction
Developing applications on your local machine is strongly recommended as it saves on headaches with using shared OPIs and allows for robust testing on a simulated machine before launching in production.
Info |
---|
Some of the following installations will run into "module not found" errors. If that is the case, simply pip install the missing module and try again |
Prerequisites
It is recommended that you already have working conda installation and have beginner's knowledge of conda environments, as well as git version control.
...
Getting Started
- Install conda if you don't have an existing installation
- Take a quick look at conda environments, the Getting Started with Conda page
...
- , and this useful conda cheatsheet
- Take a quick look at this git version control intro
- Read through this quick primer on environment variables
Installing PyDM
The basic steps can be found in the official documentation, but some quality of life improvements include:
...
- Run
conda install --update-all --force-reinstall -y -c conda-forge bmad
- Run
git clone git@github.com:slaclab/lcls-lattice.git
- This repo can live wherever, just remember where it lives
- Set the
LCLS_LATTICE
environment variable to wherever the repo in step 2 lives - Run
git clone git@github.com:slaclab/simulacrum.git
and remember where it lives - Append the path from step 4 to your python path in your environment variable file using
export PYTHONPATH="${PYTHONPATH}:<path/to/simulacrum/repo>"
- Run
python <service directory>/<service>.py
for any service you want runningThis will eat a terminal tab. I strongly advise against backgrounding because you'll need to kill the process eventually, and if you background it you'll either need to remember the process ID or find it later
Info |
---|
Sometimes running a service for the first time will generate "module not found" errors. If that is the case, simply pip install the missing module and try again |
Installing LCLS Tools
A shared library used by most (if not all) SRF software
...