Skip to main content

OCS Control Programs for running the observatory.

Project description

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

Overview

A high level library for running observatory operations. sorunlib handles connecting to and controlling multiple OCS Agents, sending the appropriate commands for orchestrating observations for a single telescope platform.

Installation

Install and update using pip:

$ pip install -U sorunlib

Install optional dependencies with:

$ pip install -U sorunlib[dev]
$ pip install -U sorunlib[docs]
$ pip install -U sorunlib[dev,docs]

Documentation

The sorunlib documentation can be built using Sphinx. Be sure to install the optional “docs” dependencies when installing above. Then run:

$ cd docs/
$ 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 can be run using pytest, and should be run from the tests/ directory:

$ cd tests/
$ python3 -m pytest

Contributing

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

License

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

Project details


Download files

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

Source Distribution

sorunlib-0.1.32.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

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

sorunlib-0.1.32-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

Details for the file sorunlib-0.1.32.tar.gz.

File metadata

  • Download URL: sorunlib-0.1.32.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for sorunlib-0.1.32.tar.gz
Algorithm Hash digest
SHA256 961a47dabb3e1c3a22f4fea05cfc268830f92c7f3c315b9b7c9a1c0e9c102251
MD5 16b78a0d77cbd87e8b85b769f6b9473e
BLAKE2b-256 ff509eca68bfe0913126aa38e7b2a17b030d9fc866d0fddfc2fd064006fbd35c

See more details on using hashes here.

File details

Details for the file sorunlib-0.1.32-py3-none-any.whl.

File metadata

  • Download URL: sorunlib-0.1.32-py3-none-any.whl
  • Upload date:
  • Size: 24.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for sorunlib-0.1.32-py3-none-any.whl
Algorithm Hash digest
SHA256 7423f7763daf505e7ec85e7b4fac8804a618199560fcdfdbac955371f67164ad
MD5 8effbd5e2b95351339bddac65076e21e
BLAKE2b-256 0bbfff81c692fe1afd31b37d690fb88134a2f088c3c39e3a0544706945d11c74

See more details on using hashes here.

Supported by

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