Skip to main content

SOCS - Simons Observatory Control System

PyPI Package PyPI - Python Version docker PyPI - License
GitHub Workflow Status pre-commit.ci status coverage Documentation Status

Overview

This repository, SOCS, contains hardware control code for the Simons Observatory. This code operates within the framework provided by OCS.

Installation

Install and update with pip:

$ python -m pip install -U socs

You may install optional dependencies by including one or more agent group names on installation, for example:

$ python -m pip install -U socs[labjack,synacc]

For a complete list of agent groups see the Installation Documentation.

If you would like to install all optional dependencies use the special varient “all”:

$ python -m pip install -U socs[all]

Note: Not all optional dependencies can be installed this way. See the Installation Documentation for more info on specific agent dependencies.

Installing from Source

If you are considering contributing to SOCS, or would like to use an unreleased feature, you will want to install from source. To do so, clone this repository and install using pip:

$ git clone https://github.com/simonsobs/socs.git
$ cd socs/
$ python -m pip install -r requirements.txt
$ python -m pip install .

Docker Images

Docker images for SOCS and each Agent are available on Docker Hub. Official releases will be tagged with their release version, i.e. v0.1.0. These are only built on release, and the latest tag will point to the latest of these released tags. These should be considered stable.

Test images will be tagged with the latest released version tag, the number of commits ahead of that release, the latest commit hash, i.e. v0.0.2-81-g9c10ba6-dev. These get built on each commit to the main branch, and are useful for testing and development, but should be considered unstable.

Documentation

The SOCS documentation can be built using Sphinx. There is a separate requirements.txt file in the docs/ directory to install Sphinx and any additional documentation dependencies:

$ cd docs/
$ python -m pip install -r requirements.txt
$ make html

You can then open docs/_build/html/index.html in your preferred web browser. You can also find a copy hosted on Read the Docs.

Tests

The tests for SOCS are run using pytest, and should be run from the tests/ directory:

$ cd tests/
$ python -m pytest --cov

For more details see tests/README.rst.

Contributing

For guidelines on how to contribute to SOCS see CONTRIBUTING.rst.

License

This project is licensed under the BSD 2-Clause License - see the LICENSE.txt file for details.

Metadata

Release files for socs 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for socs 0.7.0
File Size Uploaded Provenance Actions
socs-0.7.0.tar.gz 468.6 kB With provenance Details for socs-0.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for socs 0.7.0
File Interpreter ABI Platform Actions
socs-0.7.0-py3-none-any.whl Python 3 none any Details for socs-0.7.0-py3-none-any.whl

Total release size: 1.0 MB

Release files / socs-0.7.0.tar.gz

Download URL socs-0.7.0.tar.gz
Size 468.6 kB
Tags Source
SHA-256 checksum
How to use checksums
628eef277a7ce8cb68d992611cde702487b7d863b7b283333f76e04cf1e39c29
BLAKE2b-256 checksum
How to use checksums
590d17e5569cf8a3e028a635807046a1e7dde90bc03bf65eaae3f0afeec3860f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Release files / socs-0.7.0-py3-none-any.whl

Download URL socs-0.7.0-py3-none-any.whl
Size 558.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d396bbdec21aad799d8dc5eb19787dac8d217578ed2d16c75479a8a7e8e238de
BLAKE2b-256 checksum
How to use checksums
cec6a3fa5688e78bbb75a1dd3f2deb6cc2ba8fc1743175b699d78e598e09e48a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Security for socs 0.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for socs-0.7.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.7.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page