pysmurf-slac 11.0.2

The python control software for SMuRF

pysmurf

DOE Code

The python control software for SMuRF. Includes scripts to do low level commands as well as higher level analysis.

Installation

Install pysmurf using pip:

pip3 install pysmurf-slac

Installing from Source

To install from source clone this repository and install using pip:

git clone https://github.com/slaclab/pysmurf.git
cd pysmurf/
pip3 install .

Documentation

Documentation is built using Sphinx, and follows the NumPy Style Docstrings convention. To build the documentation first install the pysmurf package, then run:

cd docs/
make html

Output will be located in _build/html. You can view the compiled documentation by opening _build/html/index.html in the browser of your choice.

The documentation is also updated to readthedocs here: https://pysmurf.readthedocs.io/en/main/