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.31.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.31-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sorunlib-0.1.31.tar.gz
  • Upload date:
  • Size: 20.3 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.31.tar.gz
Algorithm Hash digest
SHA256 408a6bfc3152388fbd8ff0ee2054456a23b8e333e8c2cb09c0ce6f8ade453619
MD5 6a774a2a23232e5fcd9ca17b0f5eefdb
BLAKE2b-256 d6841fac7c3abe4a46d31965acc5e463c60efe0cb0b2ee0606077e2c5ab04e4e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sorunlib-0.1.31-py3-none-any.whl
  • Upload date:
  • Size: 24.3 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.31-py3-none-any.whl
Algorithm Hash digest
SHA256 1634baf02e69e9d27ceb13f0d637f900637e64bc9ee5d5dbf62fa9e6e022b1f5
MD5 d33e9e079e44b1a349ee73075de19340
BLAKE2b-256 7ce00095d72a57eaca935d33a545bdd008488dc1cf6ed9a9e3bd435aaa294987

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