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.30.tar.gz (20.3 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.30-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sorunlib-0.1.30.tar.gz
Algorithm Hash digest
SHA256 498e07797060e18a1400674e7cae6b6ca7c6f3b641013dbc05d01857c9030a19
MD5 ceecabc44487c1dcd519c2f3bf72644d
BLAKE2b-256 4d12344df9d0fafa79d08288e7ef8345cfae1fb4c318be467926d403e96098b0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sorunlib-0.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 fabdcdb7cfc87ac453d57fd229019e48cfacd357154bc33559a4ed895d3207f5
MD5 233a78640ff67ad5364463fb1d92a758
BLAKE2b-256 cba88f5b55f590c0b7ccce07f80ab952e419f269d3f739c007cee9ebefc98afc

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