Metadata-Version: 2.1
Name: sorunlib
Version: 0.1.2rc5
Summary: OCS Control Programs for running the observatory.
Home-page: https://github.com/simonsobs/sorunlib
License: UNKNOWN
Project-URL: Source Code, https://github.com/simonsobs/sorunlib
Project-URL: Documentation, https://sorunlib.readthedocs.io
Project-URL: Bug Tracker, https://github.com/simonsobs/sorunlib/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: tests
Provides-Extra: docs
License-File: LICENSE.txt

========
sorunlib
========

.. image:: https://img.shields.io/github/workflow/status/simonsobs/sorunlib/Run%20Tests
    :target: https://github.com/simonsobs/sorunlib/actions?query=workflow%3A%22Run+Tests%22
    :alt: GitHub Workflow Status

.. image:: https://readthedocs.org/projects/sorunlib/badge/?version=latest
    :target: https://sorunlib.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://coveralls.io/repos/github/simonsobs/sorunlib/badge.svg?branch=main
    :target: https://coveralls.io/github/simonsobs/sorunlib?branch=main

.. image:: https://img.shields.io/pypi/v/sorunlib
   :target: https://pypi.org/project/sorunlib/
   :alt: PyPI Package

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`_.

.. _Read the Docs: https://sorunlib.readthedocs.io/en/latest/

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`_.

.. _CONTRIBUTING.rst: https://github.com/simonsobs/sorunlib/blob/main/CONTRIBUTING.rst

License
-------

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

.. _LICENSE.txt: https://github.com/simonsobs/sorunlib/blob/main/LICENSE.txt


