v0.3.1

What's Changed

New Agents

• Created pfeiffer turbo controller agent by @JakeSpisak in #149
• Magpie agent by @jlashner in #178
• Created hwp rotation agent by @bbixler500 in #157

New Features

• Add SNMP version support to M1000 Agent and fix other bugs by @BrianJKoopman in #275
• Scpi psu monitor update by @mjrand in #284
• Magpie detector monitoring in grafana by @jlashner in #282
• Smurf file emulator realistic g3 by @jlashner in #283
• Add functionality for LS372 Agent to Initialize Device/Channel Settings Using Config File by @sanahabhimani in #276
• Pysmurf controller tasks by @jlashner in #280

Documentation Updates

• Write sequencer docs page by @BrianJKoopman in #268
• Misc docs fixes by @BrianJKoopman in #279

Bug Fixes

• Fix npy extension issue by @jlashner in #248
• Fix CI Wheel Builds by @BrianJKoopman in #257
• pip install socs directly from socs repo in pysmurf-controller image by @BrianJKoopman in #258
• Fix pysmurf archiver docker build and test future builds on PRs by @BrianJKoopman in #265
• Small bugfix for pysmurf monitor by @jlashner in #263
• Fix labjack acq task and format new task docstring by @BrianJKoopman in #277
• Replace ls372 simulator with device emulator in integration tests by @BrianJKoopman in #285

Misc.

• Add ipython notebooks to gitignore by @BrianJKoopman in #271
• Separate shared code from several PRs by @BrianJKoopman in #270
• Remove several old Agents by @BrianJKoopman in #278
• Reduce duplicate and unecessary github action workflow triggers, reuse actions where possible by @BrianJKoopman in #286
• Only run dummy workflow on PRs not on push by @BrianJKoopman in #288
• Replace docker login with docker/login-action by @BrianJKoopman in #289
• Bump actions/setup-python from 2 to 3 by @dependabot in #290
• Bump actions/checkout from 2 to 3 by @dependabot in #291
• Implement hwp rotation agent review suggestions, remove need for telnet, add tests by @BrianJKoopman in #281
• Configure pre-commit by @BrianJKoopman in #287
• Bump docker/login-action from 1 to 2 by @dependabot in #292

New Contributors

• @dependabot made their first contribution in #290
• @bbixler500 made their first contribution in #157

Full Changelog: v0.3.0...v0.3.1

v0.3.0

Description

v0.3.0 introduces many new Agents to socs, as well as some new testing functionality. It is also the first release on PyPI. See full change log below.

Update Instructions

You can update by using the new v0.3.0 Docker image tags for your Dockerized Agents. For any Agents running directly on a host system you can update by pulling the latest changes to your local repository.

Lakeshore372 Agent

Special care for the Lakeshore372 Agent might be needed while updating. If you updated sometime after #190, but before #246 you might have needed to change your 372 Agent's ocs site configuration block in order to acquire data at Agent startup.

If you would like to have the Agent automatically acquire data startup, make sure you have:

['--mode', 'acq'],

and that you do not have:

['--auto-acquire'],

in your configuration.

Change Log

New Agents

• Weather monitor agent (#82)
• FTS Agent (#160)
• Vertex ACU Agent (#156)
• Lakeshore336 Agent (#111)
• Smurf file emulator (#216)
• SupRsync Agent (#222)
• Lakeshore425 Agent (#221)

New Features

• Adds an OCS pathway for smurf metadata (#133)
• Record LS372 Sample Heater (#176)
• Control input for ls 372 (#190)
• Create example Agent unit tests (#196)
• Create integration tests for the Lakeshore 372 Agent (#198)
• Ls372 more functions (#213)
• Lakeshore425 Agent Suggestions (#225)
• Device Emulator pytest Fixture (#228)
• update LS372 sampling rate (#231)
• Add ability to read out custom registers from labjack agent (#173)
• Build and Deploy socs to PyPI (#240)
• Replace --auto-acquire with --mode in 372 Agent (#246)
• Add TCP relay to device emulator (#254)

Documentation Updates

• Add network_mode to docker-compose example in SCPI PSU Agent docs (#170)
• Docs (#172)
• Update bluefors agent docker config example (#180)
• Update smurf crate monitor agent docs to use docker hub image (#186)
• Catch up with recent docs conf.py changes in OCS (#193)
• Standardize LS372Agent docs (#194)
• Hack day Agent docs standardization changes (#208)
• Remove documentation build test from all workflows (#207)
• Replace css file path specification in Sphinx config (#210)
• Pin docutils and add readthedocs config file (#209)
• Fix testing docs API autodoc (#237)

Bug Fixes

• Handle LS372 ConnectionError if device powered off at Agent startup (#168)
• LATRt Stage Update (#159)
• Bluefors inode handling (#174)
• very small fix on hwpbbb agent. add type=int for port number (#215)
• Labjack bugfixes (#217)
• Enforce ordering of tests for spt3g dependency check (#223)
• ls240: Fix arg parsing in LS240 Agent (#232)
• cpa_agent: Cast port to int before device setup (#233)
• Fix flaky ls372 acq test (#243)
• Handle ssh key in SupRsync Agent (#244)

Misc.

• bump sodetlib and remove ocs install (#171)
• Remove deprecated reparse_args from all Agents (#192)
• Update ocs base image to v0.8.0-83-g13be6e8-dev (#197)
• Update ocs and sodetlib base versions (#220)
• Change default port for crossbar used in testing (#227)
• Create Lakeshore425 Agent integration tests (#229)
• changes monitor to use Feed.enforce_field_name_rules (#241)
• Expand base test coverage for agents (#245)
• Create integration tests for the LS240 Agent (#242)

v0.2.0

Description

v0.2.0 includes several new Agents, some new features, and bug fixes.

One major change includes replacing 'sisock-crossbar' with 'crossbar' (#118), which might require a configuration file change if your setup still refers to the old sisock images. It should be enough to replace all instances of 'sisock-crossbar' with 'crossbar' in your configs.

The base images are now based on Ubuntu 20.04, where they previously were based on Ubuntu 18.04. This was required to fix the build process and hasn't introduced any surprises based on testing so far.

Change Log

New Agents

• Created smurf crate monitor agent (#139)
• Add XY Stage Agent for LATRt Stages (#153)
• Lakeshore 370 Agent (#161)
• New CHWP encoder readout agent (#80)

New Features

• Replace 'sisock-crossbar' with 'crossbar' (#118)
• Bump sodetlib version to v0.1.0 (#127)
• Implement labjack ljm functionality to allow high sample rates (#129)
• Added dumb-init to pysmurf-controller reqs (#131)
• Add some quality of life improvements to smurf-rec (#134)
  • Remove check_port test (#146 )
• Adds set_status calls to some operations within Smurf Agents (#135)
• Update to Ubuntu 20.04 based ocs image (#138)
• Tektronix awg Agent updates (#142)
• Prologix interface inheritance (#144)
• Add stream-id argument to smurf stream simulator agent (#150)
• Added set_still_heater() and get_still_heater() to LS372 agent (#163)
• Update ocs base image to v0.8.0 (#167)

Documentation Updates

• Link readthedocs badge to 'develop' version (97ce65f)
• Add Synaccess Agent docs to index and alphabetize (1be403b)
• Fix docstring on TektronixAWGAgent class (#143)
• Remove mention of sisock data feed servers from 372 docs (#148)
• Protect ocs import on rtd in crate manager agent (8128c64)

Bug Fixes

• Clamp ds_factor in smurf recorder (#123)
• Handle nan in smurf_recorder read_stream_data (#130)
• Catch labjack stream error (#136)
• Fix bug that prevents npy files from being archived (#137)

Misc

• Update coveralls command for v3.0.0 (#132)

v0.1.0

Description

v0.1.0 of socs introduces several new Agents that have been in the develop branch for while now. It also includes new features such at the SMuRF stream monitor, for viewing downsampled timestreams of select detectors in the HK feeds. Bringing the base ocs version up to the latest v0.7.1 also includes an update which makes Agents robust against short term crossbar server disconnections. Full change log below.

One breaking change that needs some attention when upgrading is the move from the default name of the crossbar server of 'sisock-crossbar' to simply just 'crossbar'. This change was motivated upstream in OCS by simonsobs/ocs#135, and changes the default commands within Dockerfiles for the Agents. To update, you should replace all instances of sisock-crossbar in your docker and ocs-site configuration files with crossbar. Documentation has been updated to reflect this change.

Change Log

New Features

• Update to ocs v0.7.1 (#116)
• Add stream monitor to smurf_recorder Agent (#113)
• Add latest data to session.data in Lakeshore Agents (#110)
• Add stream_id component to smurf recorder file path (#105)
• Add ljm module to LabJack Agent (#104)
• Create Synaccess PDU Agent (#103)
• Allow file check skip in rename_fields script (#102)
• Create M1000 Agent and add SNMP support (#101)
• Update to cryomech agent fields (#90)
• Add flow control handling to smurf recorder (#46)
• Create smurf recorder unit tests (#50)
• Adds pysmurf actions to the pysmurf archiver path (#53)
• session_data pathway for pysmurf-controller (#54)
• Create LabJack Agent (#67)
• Add yielding lock which adds "release_and_acquire" (#69)
• Added table versioning and failed copy limit (#70)
• Add psu status query to scpi_psu Agent (#72)
• Add LabJack unit conversion (#75)
• Replace 'sisock-crossbar' with 'crossbar' (#118)

Documentation Updates

• Test docs build in CI pipeline (#95)

Bug Fixes

• Add new status log fields to Bluefors Agent (#114)
• Use 'dumb-init' to start Agents within containers (#107)
• Patch Lakeshore curve upload to handle variable length files (#97)
• Fix typos in Pfeiffer agent (#89)

Misc

• Switch from Travis CI to GitHub Actions (#92)

v0.0.2

Another long overdue version update... Here's some things that've been added:

• Lots of new agents, including
  • cryomech_cpa
  • updated pysmurf controller/monitor/archiver
  • timestream_aggregator and smurf_stream_simulator
• Simulators for the LS240 and LS372
• Lots of documentation

v0.0.1

This is long overdue. First tagged release of socs. This separates SO specific OCS agents and code from the OCS repository. Since the initial split several new Agents have been developed.