Metadata-Version: 2.1
Name: pydarm
Version: 0.1.1
Summary: pyDARM modeling package for LIGO detector calibration
Author-email: Evan Goetz <evan.goetz@ligo.org>
License: GPL-3.0-or-later
Project-URL: Source Code, https://git.ligo.org/Calibration/pydarm
Project-URL: Bug Tracker, https://git.ligo.org/Calibration/pydarm/-/issues
Project-URL: Documentation, https://calibration.docs.ligo.org/pydarm
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: conda
License-File: LICENSE

# pyDARM

[![PyPI version](https://badge.fury.io/py/pydarm.svg)](https://badge.fury.io/py/pydarm)
[![Conda version](https://img.shields.io/conda/vn/conda-forge/pydarm.svg)](https://anaconda.org/conda-forge/pydarm/)
[![License](https://img.shields.io/pypi/l/pydarm.svg)](https://choosealicense.com/licenses/gpl-3.0/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydarm.svg)

pyDARM is a python implementation of the LIGO DARM servo loop
model. It is used to calibrate the detector digital output into units
of differential arm length variations or spacetime strain.

If you need assistance, please review INSTALL.md and CONTRIBUTING.md
for detailed installation instructions and contribution guidelines,
respectively.

## Installation

For best results, please install from [conda-forge](https://conda-forge.org/):

```shell
conda install -c conda-forge pydarm
```

On Unix systems, you can also install directly from PyPI:

```shell
pip install pydarm
```

## Basic usage

See the [web-based documentation](https://calibration.docs.ligo.org/pydarm) and/or [examples](examples) directory
for examples of library usage. You can use pyDARM either from `python`, `ipython`, or a
jupyter notebook, depending on your preferences.

### Command line interface

pyDARM will eventually include a command line interface to help guide through the
calibration process.  See the command help for more info:
```shell
$ python3 -m pydarm --help
```
