Socs

Description
This release mostly focuses on bug fixes and new features, particularly with the SMuRF File Emulator and ACU Agents. This release also introduces the new SMuRF Timing Card Agent.

The branches in the repo used have changed a bit as well. We have dropped the old `develop` and `master` branch split in favor of a single branch, `main`. Contributors should base new work off of the `main` branch moving forward.

What's Changed

New Agents
* Smurf Timing Card Agent by jlashner in https://github.com/simonsobs/socs/pull/422

New Features
* Add LS372 Custom PID Start Process + Other Tasks by sanahabhimani in https://github.com/simonsobs/socs/pull/397
* File emulator quantization by jlashner in https://github.com/simonsobs/socs/pull/425
* Acu aug lat updates by laurensaunders in https://github.com/simonsobs/socs/pull/403

Bug Fixes
* suprsync: fix unformatted log message by mhasself in https://github.com/simonsobs/socs/pull/414
* Catch error in device emulator when binding to port by BrianJKoopman in https://github.com/simonsobs/socs/pull/413
* Fix docs build warnings in ups agent docstring by BrianJKoopman in https://github.com/simonsobs/socs/pull/426
* Fixes sampling issues with file emulator by jlashner in https://github.com/simonsobs/socs/pull/428

Testing Updates
* Move port numbers for binding in common tests by BrianJKoopman in https://github.com/simonsobs/socs/pull/412
* Pysmurf Monitor Integration Test by erfz in https://github.com/simonsobs/socs/pull/343

Version Updates
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/423

Misc.
* Replace master and develop branches with "main" branch by BrianJKoopman in https://github.com/simonsobs/socs/pull/410
* Remove stray links to 'master' branch by BrianJKoopman in https://github.com/simonsobs/socs/pull/411
* Add missing __init__.py for two agents by mhasself in https://github.com/simonsobs/socs/pull/416


**Full Changelog**: https://github.com/simonsobs/socs/compare/v0.4.1...v0.4.2

Description
This release is mostly focused on bug fixes, particularly related to the pysmurf-controller Agent. Issues with pysmurf-controller in the v0.4.0 release were mostly related to packaging and dependencies, which are resolved in this release. Users should update to v0.4.1, especially if they are currently using v0.4.0.

Also included in this release is the new UPS Agent. See the Agent Reference page for details on configuration.

Users who are still on `socs<0.4.0` should be sure to read the [release notes for v0.4.0](https://github.com/simonsobs/socs/releases/tag/v0.4.0) before updating, as user action is required.

What's Changed

New Agents
* UPS agent & integration test by davidvng in https://github.com/simonsobs/socs/pull/362

New Features
* Pysmurf controller updates from p10r1 by jlashner in https://github.com/simonsobs/socs/pull/376
* Adds rotation arg to magpie by jlashner in https://github.com/simonsobs/socs/pull/400
* Added input OIDs to UPS agent by davidvng in https://github.com/simonsobs/socs/pull/406

Bug Fixes
* Pysmurf controller updates from p10r1 by jlashner in https://github.com/simonsobs/socs/pull/376
* Fix MIB location search for SNMP agents by BrianJKoopman in https://github.com/simonsobs/socs/pull/402

Documentation Updates
* Make docker-compose examples consistent by BrianJKoopman in https://github.com/simonsobs/socs/pull/370

Testing Updates
* Rework pysmurf controller tests for sodetlib v0.5.0 by BrianJKoopman in https://github.com/simonsobs/socs/pull/378

Version Updates
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/372
* Bump sodetlib image base version by BrianJKoopman in https://github.com/simonsobs/socs/pull/374
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/383
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/387
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/399
* Bump base ocs docker image version by BrianJKoopman in https://github.com/simonsobs/socs/pull/407

Misc.
* Remove direct references from setup.py by BrianJKoopman in https://github.com/simonsobs/socs/pull/373
* Fix github actions workflow badge by BrianJKoopman in https://github.com/simonsobs/socs/pull/382
* Removes -e from socs install by jlashner in https://github.com/simonsobs/socs/pull/393
* Bump sodetlib docker version by jlashner in https://github.com/simonsobs/socs/pull/395

**Full Changelog**: https://github.com/simonsobs/socs/compare/v0.4.0...v0.4.1

Description
This release includes a substantial restructuring of the repository to move the `agents/` directory into the `socs` package, making `socs` an [OCS Plugin](https://ocs.readthedocs.io/en/develop/developer/writing-plugins.html). 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](https://github.com/simonsobs/ocs/releases/tag/v0.10.0). **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](https://hub.docker.com/r/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 https://github.com/simonsobs/socs/pull/357

New Features
* Make socs an ocs plugin by BrianJKoopman in https://github.com/simonsobs/socs/pull/352
* Add release and acquire function to cryomech cpa agent by sanahabhimani in https://github.com/simonsobs/socs/pull/359

Documentation Updates
* More docs standarization by BrianJKoopman in https://github.com/simonsobs/socs/pull/367

Testing Updates
* Pysmurf-controller agent unit tests & agent fixes by davidvng in https://github.com/simonsobs/socs/pull/354
* Pfeiffer_tpg366 agent added test mode for integration test by davidvng in https://github.com/simonsobs/socs/pull/363
* iBootBar Integration Tests using SNMP Response Simulator by erfz in https://github.com/simonsobs/socs/pull/338
* iBootbar removed auto-start by davidvng in https://github.com/simonsobs/socs/pull/364

Version Updates
* Bump sodetlib by jlashner in https://github.com/simonsobs/socs/pull/358
* Bump styfle/cancel-workflow-action from 0.10.0 to 0.10.1 by dependabot in https://github.com/simonsobs/socs/pull/353
* Bump styfle/cancel-workflow-action from 0.10.1 to 0.11.0 by dependabot in https://github.com/simonsobs/socs/pull/356
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/360

Misc.
* Update labjack software installation in Docker build by BrianJKoopman in https://github.com/simonsobs/socs/pull/355
* Fix develop/deploy wheel tests by BrianJKoopman in https://github.com/simonsobs/socs/pull/361


**Full Changelog**: https://github.com/simonsobs/socs/compare/v0.3.2...v0.4.0

What's Changed

New Agents
* Create wiregrid_actuator and wiregrid_kikusui Agents by sadachi5 in https://github.com/simonsobs/socs/pull/183
* Create wiregrid encoder Agent by sadachi5 in https://github.com/simonsobs/socs/pull/260
* Add iBootbar agent with MIB and added set function to snmp.py by davidvng in https://github.com/simonsobs/socs/pull/306
* Create holography agents by chesmore in https://github.com/simonsobs/socs/pull/262
* Create hwp picoscope agent by ykyohei in https://github.com/simonsobs/socs/pull/226

New Features
* Scan helpers generator by laurensaunders in https://github.com/simonsobs/socs/pull/235
* Postfat updates by laurensaunders in https://github.com/simonsobs/socs/pull/294
* New parameter for scan start position in generator scans by laurensaunders in https://github.com/simonsobs/socs/pull/323
* Update FTS aerotech agent to work with multiple different FTSes by tdalford in https://github.com/simonsobs/socs/pull/272
* Add encoding argument to DeviceEmulator relays by BrianJKoopman in https://github.com/simonsobs/socs/pull/303
* Add ability to turn Cryomech CPA on/off by sanahabhimani in https://github.com/simonsobs/socs/pull/301
* Magpie updates and white noise monitor by jlashner in https://github.com/simonsobs/socs/pull/302
* Smurf emulator tune support by jlashner in https://github.com/simonsobs/socs/pull/309
* Smurf file em updates by jlashner in https://github.com/simonsobs/socs/pull/341
* Adds FrameCounter to smurf file emulator by jlashner in https://github.com/simonsobs/socs/pull/347
* Add MultiSlotController by jlashner in https://github.com/simonsobs/socs/pull/320
* Improved TimeoutLock usage in Lakeshore425 by ykyohei in https://github.com/simonsobs/socs/pull/329
* Put approx_hwp_freq in session.data object for SupervisorAgent by ykyohei in https://github.com/simonsobs/socs/pull/336
* New control options for suprsync by mhasself in https://github.com/simonsobs/socs/pull/345
* Modify synacc to record synaccess switch on/off by sadachi5 in https://github.com/simonsobs/socs/pull/183

Documentation Updates
* Add mock for rotation agent to docs/conf.py by BrianJKoopman in https://github.com/simonsobs/socs/pull/300
* suprsync: Remove old arg from example config by BrianJKoopman in https://github.com/simonsobs/socs/pull/332
* Fix single test file run example by BrianJKoopman in https://github.com/simonsobs/socs/pull/307

Bug Fixes
* Acu commanded position None handling by laurensaunders in https://github.com/simonsobs/socs/pull/236
* Fix Cryomech CPA Agent acq process auto start by BrianJKoopman in https://github.com/simonsobs/socs/pull/314
* Attempt failed connection again in pid_controller by BrianJKoopman in https://github.com/simonsobs/socs/pull/328
* Suprsync update copy attempts by jlashner in https://github.com/simonsobs/socs/pull/337

Testing Updates
* Create Cryomech CPA Agent tests by BrianJKoopman in https://github.com/simonsobs/socs/pull/304
* Add integration test for SCPI PSU Agent by erfz in https://github.com/simonsobs/socs/pull/311
* Implement Pfeiffer TPG366 integration test by erfz in https://github.com/simonsobs/socs/pull/326
* Add Synacc integration test using mock HTTP test server by erfz in https://github.com/simonsobs/socs/pull/330

Version Updates
* Bump ocs to v0.9.3 and increase required Python version by BrianJKoopman in https://github.com/simonsobs/socs/pull/316
* Bump actions/setup-python from 3 to 4 by dependabot in https://github.com/simonsobs/socs/pull/305
* Bump styfle/cancel-workflow-action from 0.9.1 to 0.10.0 by dependabot in https://github.com/simonsobs/socs/pull/317
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/298
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/308
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/334
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/339
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/simonsobs/socs/pull/342

Misc.
* Run end-of-line-fixer and trailing-whitespace pre-commit hooks on all files by BrianJKoopman in https://github.com/simonsobs/socs/pull/296
* Run autopep8 on all files by BrianJKoopman in https://github.com/simonsobs/socs/pull/297
* Run flake8 on all files by BrianJKoopman in https://github.com/simonsobs/socs/pull/299
* Run pre-commit hooks on ACU files by BrianJKoopman in https://github.com/simonsobs/socs/pull/310
* Run pytest workflow PR only and fix wildcard pattern matching by BrianJKoopman in https://github.com/simonsobs/socs/pull/312
* Install socs from temp branch w/o python_requires>=3.7 by BrianJKoopman in https://github.com/simonsobs/socs/pull/319
* Remove stray print in SupRsync by jlashner in https://github.com/simonsobs/socs/pull/322
* Add ibootbar agent to docker-compose file by BrianJKoopman in https://github.com/simonsobs/socs/pull/331
* Simulator related ACU Agent Updates by BrianJKoopman in https://github.com/simonsobs/socs/pull/324

New Contributors
* pre-commit-ci made their first contribution in https://github.com/simonsobs/socs/pull/298
* tdalford made their first contribution in https://github.com/simonsobs/socs/pull/272
* sadachi5 made their first contribution in https://github.com/simonsobs/socs/pull/183
* erfz made their first contribution in https://github.com/simonsobs/socs/pull/311
* davidvng made their first contribution in https://github.com/simonsobs/socs/pull/306
* chesmore made their first contribution in https://github.com/simonsobs/socs/pull/262

**Full Changelog**: https://github.com/simonsobs/socs/compare/v0.3.1...v0.3.2

What's Changed

New Agents
* Created pfeiffer turbo controller agent by JakeSpisak in https://github.com/simonsobs/socs/pull/149
* Magpie agent by jlashner in https://github.com/simonsobs/socs/pull/178
* Created hwp rotation agent by bbixler500 in https://github.com/simonsobs/socs/pull/157

New Features
* Add SNMP version support to M1000 Agent and fix other bugs by BrianJKoopman in https://github.com/simonsobs/socs/pull/275
* Scpi psu monitor update by mjrand in https://github.com/simonsobs/socs/pull/284
* Magpie detector monitoring in grafana by jlashner in https://github.com/simonsobs/socs/pull/282
* Smurf file emulator realistic g3 by jlashner in https://github.com/simonsobs/socs/pull/283
* Add functionality for LS372 Agent to Initialize Device/Channel Settings Using Config File by sanahabhimani in https://github.com/simonsobs/socs/pull/276
* Pysmurf controller tasks by jlashner in https://github.com/simonsobs/socs/pull/280

Documentation Updates
* Write sequencer docs page by BrianJKoopman in https://github.com/simonsobs/socs/pull/268
* Misc docs fixes by BrianJKoopman in https://github.com/simonsobs/socs/pull/279

Bug Fixes
* Fix npy extension issue by jlashner in https://github.com/simonsobs/socs/pull/248
* Fix CI Wheel Builds by BrianJKoopman in https://github.com/simonsobs/socs/pull/257
* pip install socs directly from socs repo in pysmurf-controller image by BrianJKoopman in https://github.com/simonsobs/socs/pull/258
* Fix pysmurf archiver docker build and test future builds on PRs by BrianJKoopman in https://github.com/simonsobs/socs/pull/265
* Small bugfix for pysmurf monitor by jlashner in https://github.com/simonsobs/socs/pull/263
* Fix labjack acq task and format new task docstring by BrianJKoopman in https://github.com/simonsobs/socs/pull/277
* Replace ls372 simulator with device emulator in integration tests by BrianJKoopman in https://github.com/simonsobs/socs/pull/285

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

New Contributors
* dependabot made their first contribution in https://github.com/simonsobs/socs/pull/290
* bbixler500 made their first contribution in https://github.com/simonsobs/socs/pull/157

**Full Changelog**: https://github.com/simonsobs/socs/compare/v0.3.0...v0.3.1

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)