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.
2 maintainers
Metadata
2 maintainers
Release files for socs 0.6.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| socs-0.6.3.tar.gz | 461.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| socs-0.6.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.0 MB
Release files / socs-0.6.3.tar.gz
| Download URL | socs-0.6.3.tar.gz |
|---|---|
| Size | 461.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42c2f83dddab23275909a03415fe38a2a76435485d4ca0a174821187c454b024
|
|
BLAKE2b-256 checksum How to use checksums |
c92167e98d702512c0dd0ca0d0ee00503901c7c335938eafe38b4ee249c3da5b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 Jul 8, 2026.
Transparency logRelease files / socs-0.6.3-py3-none-any.whl
| Download URL | socs-0.6.3-py3-none-any.whl |
|---|---|
| Size | 551.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2ed4b308583471b09a7c100fec93f466d6b7bbffae9baeba168fb86f556d2724
|
|
BLAKE2b-256 checksum How to use checksums |
3f7697f36450ec96ce47edb5fb3dd098d26e14b2b7728a751e937e1cfa0a6b36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 Jul 8, 2026.
Transparency log
