Metadata-Version: 2.4
Name: sodetlib
Version: 0.6.4
Summary: Simons Observatory detector readout library.
Project-URL: Bug Tracker, https://github.com/simonsobs/sodetlib/issues
Project-URL: Documentation, https://sodetlib.readthedocs.io
Project-URL: Homepage, https://github.com/simonsobs/sodetlib
Project-URL: Source Code, https://github.com/simonsobs/sodetlib
License-Expression: BSD-2-Clause
License-File: LICENSE
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.8
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pysmurf-slac
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: setuptools-scm; extra == 'dev'
Provides-Extra: scripts
Requires-Dist: ipython; extra == 'scripts'
Requires-Dist: traitlets; extra == 'scripts'
Description-Content-Type: text/x-rst

========
sodetlib
========

| |pypi| |versions| |license| |docs|

This repository contains tools for controlling the Simons Observatory readout
system, and performing initial data analysis for detector characterization.

Installation
------------

Instructions for setting up a SMuRF server can be found on `Confluence`_.

For offline analysis of sodetlib data files, you can also install sodetlib
by cloning this repo and running::

    $ python -m pip install -r requirements.txt
    $ python -m pip install .

.. _`Confluence`: https://simonsobs.atlassian.net/wiki/spaces/PRO/pages/11041372/Smurf+Software+Setup

Documentation
-------------

The sodetlib documentation can be built using Sphinx. Once sodetlib and its
dependencies are installed run::

    $ cd docs/
    $ make html

The documentation is also hosted on `Read the Docs`_.

.. _`Read the Docs`: https://sodetlib.readthedocs.io/en/latest/

Contributing
------------

Contributions are very welcome! Pull requests must be approved by one member
of the simonsobs team before being merged.

Licence
-------

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

.. _`LICENSE`: LICENSE


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

.. |versions| image:: https://img.shields.io/pypi/pyversions/sodetlib
    :alt: PyPI - Python Version

.. |license| image:: https://img.shields.io/pypi/l/sodetlib
    :target: LICENSE
    :alt: PyPI - License

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