Skip to content

v0.10.0
Compare
Choose a tag to compare
@BrianJKoopman BrianJKoopman released this 17 Oct 18:02
· 29 commits to master since this release
v0.10.0
c50f7e5
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Description

There are several large changes in release v0.10.0. These may require user action, as described below.

ocs-web

ocs-web has been removed from this repository. It has been replaced by an improved Vue.js version kept in simonsobs/ocs-web.

Current users of ocs-web should upgrade to the new Vue.js based version. Setup instructions, including how to run with the provided Docker image, are located in the ocs-web repo's README file.

OCS Plugins

v0.10.0 adds the OCS Plugin system. This has moved all core OCS Agents to be within the ocs package. (They were previously in a separate agents/ directory.) This allows core Agent installation via pip from PyPI.

During this change all core ocs Agent Docker images have been merged into a single image. All core Agents can now be run from the simonsobs/ocs image. Configuration of the image can now largely be done by setting environment variables. For example, to run a fake data Agent a docker-compose service would look like:

fake-data1:
    image: simonsobs/ocs:v0.10.0
    hostname: ocs-docker
    environment:
      - INSTANCE_ID=fake-data1
    volumes:
      - ${OCS_CONFIG_DIR}:/config:ro

Please see each Agent's respective reference page for updated configuration file information.

Separate Agent images will not be built moving forward, so in order to update you must switch to using the new simonsobs/ocs:v0.10.0 image.

Task Abort

Task aborting has been a long planned feature of ocs. It is now implemented. Agent developers can now add the ability to abort tasks. You can read about how to do so in the newly re-written Agent Writing Guide. More specifically see "Aborting a Task".

OCS now tries to run the Process stop command in the same threading context as the Process itself (the same is true for Task aborts.) Existing Agents with their process start/stop commands in differing contexts can still be run, but OCS will print a warning. Agent developers are encouraged to put their start/stops in the same context. See the Agent guide above for details.

What's Changed

New Features

Documentation Updates

Bug Fixes

Misc.

Full Changelog: v0.9.3...v0.10.0

Contributors

mhasself and BrianJKoopman
Assets 2