v0.4.0

[BrianJKoopman]

Description

This release includes a substantial restructuring of the repository to move the agents/ directory into the socs package, making socs an OCS Plugin. This makes the Agents available through the package for the first time. OCS Plugins are new feature as of ocs v0.10.0, for more details please see the ocs release notes. Updating to socs v0.4.0 requires some user action, as described below.

Docker Image Merger

Along with this restructuring comes a merger of most of the Docker images used to run the socs Agents. Most of the Agents can now be run off of a single image, simonsobs/socs. The only Agents not covered by this are the HWP Picoscope, Pysmurf Controller, and Wiregrid Actuator Agents.

Required Actions

The merger of the Docker images requires users who update to v0.4.0 to update their docker-compose files to use this common image (old per-agent images are no longer published, except for the Agents called out above), and to set common configuration variables via the environment: field, such as the instance-id, site-hub, and site-http arguments. For examples, please see any given Agent's reference page in the documentation.

To discuss these changes, please use the GitHub Discussion linked to this release. For any issues that arise in this release, especially due to this restructuring, please file a GitHub Issue.

What's Changed

New Agents

• Chopper MC2000B Agent by @sanahabhimani in Chopper MC2000B Agent #357

New Features

• Make socs an ocs plugin by @BrianJKoopman in Make socs an ocs plugin #352
• Add release and acquire function to cryomech cpa agent by @sanahabhimani in Add release and acquire function to cryomech cpa agent #359

Documentation Updates

• More docs standarization by @BrianJKoopman in More docs standarization #367

Testing Updates

• Pysmurf-controller agent unit tests & agent fixes by @davidvng in Pysmurf-controller agent unit tests & agent fixes #354
• Pfeiffer_tpg366 agent added test mode for integration test by @davidvng in Pfeiffer_tpg366 agent added test mode for integration test #363
• iBootBar Integration Tests using SNMP Response Simulator by @erfz in iBootBar Integration Tests using SNMP Response Simulator #338
• iBootbar removed auto-start by @davidvng in iBootbar removed auto-start #364

Version Updates

• Bump sodetlib by @jlashner in Bump sodetlib #358
• Bump styfle/cancel-workflow-action from 0.10.0 to 0.10.1 by @dependabot in Bump styfle/cancel-workflow-action from 0.10.0 to 0.10.1 #353
• Bump styfle/cancel-workflow-action from 0.10.1 to 0.11.0 by @dependabot in Bump styfle/cancel-workflow-action from 0.10.1 to 0.11.0 #356
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in [pre-commit.ci] pre-commit autoupdate #360

Misc.

• Update labjack software installation in Docker build by @BrianJKoopman in Update labjack software installation in Docker build #355
• Fix develop/deploy wheel tests by @BrianJKoopman in Fix develop/deploy wheel tests #361

Full Changelog: v0.3.2...v0.4.0

---

This discussion was created from the release v0.4.0.

[BrianJKoopman]

Publication of v0.4.0 to PyPI is unfortunately broken due to the use of direct references in the setup.py file. This appears to violate PEP-0440.

A solution is being worked out, but for now the dependencies can be installed by cloning the repository and either installing directly from the repo with:

$ pip install .

(This will also install socs.)

Or by using the requirements file with:

$ pip install -r requirements.txt

(This will install just the dependencies, and not socs.)

v0.4.0 might make its way to PyPI with these dependencies removed, in which case installing with the requirements file as shown above is likely your best bet. Look out for release v0.4.1 that'll offer a more permanent solution.