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:

$ pip3 install -U socs

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

$ pip3 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”:

$ pip3 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/
pip3 install -r requirements.txt
pip3 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/
pip3 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/
$ python3 -m pytest --cov

For more details see tests/README.rst.

Contributing

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

License

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

Project links

Data verified by PyPI on Jul 8, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for BrianJKoopman from gravatar.com BrianJKoopman Avatar for mhasself from gravatar.com mhasself

GitHub Statistics

Data verified by PyPI on Jul 8, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD License

Requires

Python >=3.8

Provides Extra

acu all camera labjack magpie pfeiffer pysmurf smurf-sim timing-master

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

socs-0.6.3.tar.gz (461.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

socs-0.6.3-py3-none-any.whl (551.4 kB view details)

Uploaded Python 3

File details

Details for the file socs-0.6.3.tar.gz.

File metadata

  • Download URL: socs-0.6.3.tar.gz
  • Upload date:
  • Size: 461.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for socs-0.6.3.tar.gz
Algorithm Hash digest
SHA256 42c2f83dddab23275909a03415fe38a2a76435485d4ca0a174821187c454b024
MD5 aa168c84a2b9bc0d695d9d137d5f0ce3
BLAKE2b-256 c92167e98d702512c0dd0ca0d0ee00503901c7c335938eafe38b4ee249c3da5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for socs-0.6.3.tar.gz:

Publisher: deploy.yml on simonsobs/socs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file socs-0.6.3-py3-none-any.whl.

File metadata

  • Download URL: socs-0.6.3-py3-none-any.whl
  • Upload date:
  • Size: 551.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for socs-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2ed4b308583471b09a7c100fec93f466d6b7bbffae9baeba168fb86f556d2724
MD5 20ee76a0bf7ed3263a8312b2b6e2c560
BLAKE2b-256 3f7697f36450ec96ce47edb5fb3dd098d26e14b2b7728a751e937e1cfa0a6b36

See more details on using hashes here.

Provenance

The following attestation bundles were made for socs-0.6.3-py3-none-any.whl:

Publisher: deploy.yml on simonsobs/socs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page