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.26.tar.gz (19.2 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.26-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sorunlib-0.1.26.tar.gz
Algorithm Hash digest
SHA256 74de125ce423ca683107254ca5d421c6acb4aa6c435f54722efc7f5073ea430a
MD5 e69c8570b2be47d55be6e49673d73719
BLAKE2b-256 3994e2dc1a0d921d5034a34dcd4822adb1bb7f83cca79227010bff9d3395fff1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sorunlib-0.1.26-py3-none-any.whl
Algorithm Hash digest
SHA256 ed6b0b73334f76b13b7f3ef2edc19765fd9e3d63dffead087edd2e06f5a899fb
MD5 aa54d1abf8f6a0090fb689c8d596c9b0
BLAKE2b-256 3bdf53afdb8e946c23e36dfa191f2926389dbc6516acc23f2640143b9f2b59da

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