README.md

ACSys Python DPM Client

acsys is the interface to Fermilab data acquisition and control.

EXAMPLES: If you are looking for examples to dive in on, please see the wiki examples.

Installing

acsys is available via a Fermi hosted pip repository.

python3 -m pip install acsys --extra-index-url https://www-bd.fnal.gov/pip3

The command above will get you up and going quickly. See usage examples in the wiki.

If you need to perform settings, authentication is required and thus the gssapi authentication library.

python3 -m pip install "acsys[settings]"

Note: This package only authenticates you as a user. There are other requirements to be able to set devices. Please make a request to the Controls Department for setting access.

If you would like to install all dependencies, use the following.

python3 -m pip install "acsys[all]"

Building

Make sure setup.py has the correct version number.

make

will create a source distribution at ./dist.

This should only be used for development.

make all

The above will generate "built distributions" as well as the source distributions from make.

Deploying

make deploy

The above will generate the distributions and push them to the AD Controls pip server.

Make sure to use git to tag the version.

git tag vVID

And push the tags.

git push --tags

Development

Start by installing development dependencies.

pip install -r requirements.txt

To test local modifications, use pip's editable mode.

pip install -e .