sorunlib 0.1.19

OCS Control Programs for running the observatory.

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[tests]
$ pip install -U sorunlib[docs]
$ pip install -U sorunlib[tests,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.