Metadata-Version: 2.4
Name: arrakis-server
Version: 0.4.1
Summary: Arrakis server
Project-URL: Homepage, https://git.ligo.org/ngdd/arrakis-server
Project-URL: Documentation, https://docs.ligo.org/ngdd/arrakis-server
Project-URL: Issue Tracker, https://git.ligo.org/ngdd/arrakis-server/issues
Project-URL: Source Code, https://git.ligo.org/ngdd/arrakis-server.git
Author-email: Patrick Godwin <patrick.godwin@ligo.org>
Maintainer-email: Patrick Godwin <patrick.godwin@ligo.org>
License-Expression: GPL-3.0-or-later
License-File: AUTHORS.md
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: arrakis>=0.5
Requires-Dist: gpstime
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pyarrow
Requires-Dist: ruamel-yaml
Requires-Dist: sympy
Requires-Dist: toml
Requires-Dist: typing-extensions
Provides-Extra: dev
Requires-Dist: markdown-callouts>=0.2; extra == 'dev'
Requires-Dist: markdown-exec>=0.5; extra == 'dev'
Requires-Dist: mkdocs-coverage>=0.2; extra == 'dev'
Requires-Dist: mkdocs-gen-files>=0.3; extra == 'dev'
Requires-Dist: mkdocs-literate-nav>=0.4; extra == 'dev'
Requires-Dist: mkdocs-material-igwn; extra == 'dev'
Requires-Dist: mkdocs-section-index>=0.3; extra == 'dev'
Requires-Dist: mkdocs>=1.3; extra == 'dev'
Requires-Dist: mkdocstrings[python]; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: mypy-extensions; extra == 'dev'
Requires-Dist: pip; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: toml>=0.10; extra == 'dev'
Provides-Extra: docs
Requires-Dist: markdown-callouts>=0.2; extra == 'docs'
Requires-Dist: markdown-exec>=0.5; extra == 'docs'
Requires-Dist: mkdocs-coverage>=0.2; extra == 'docs'
Requires-Dist: mkdocs-gen-files>=0.3; extra == 'docs'
Requires-Dist: mkdocs-literate-nav>=0.4; extra == 'docs'
Requires-Dist: mkdocs-material-igwn; extra == 'docs'
Requires-Dist: mkdocs-section-index>=0.3; extra == 'docs'
Requires-Dist: mkdocs>=1.3; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Requires-Dist: toml>=0.10; extra == 'docs'
Provides-Extra: lint
Requires-Dist: mypy; extra == 'lint'
Requires-Dist: mypy-extensions; extra == 'lint'
Requires-Dist: pip; extra == 'lint'
Requires-Dist: ruff; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

<h1 align="center">arrakis-server</h1>

<p align="center">Arrakis server</p>

<p align="center">
  <a href="https://git.ligo.org/ngdd/arrakis-server/-/pipelines/latest">
    <img alt="ci" src="https://git.ligo.org/ngdd/arrakis-server/badges/main/pipeline.svg" />
  </a>
  <a href="https://git.ligo.org/ngdd/arrakis-server/-/pipelines/latest">
    <img alt="ci" src="https://git.ligo.org/ngdd/arrakis-server/badges/main/coverage.svg" />
  </a>
  <a href="https://ngdd.docs.ligo.org/arrakis-server/">
    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
  </a>
  <a href="https://pypi.org/project/arrakis-server/">
    <img alt="pypi version" src="https://img.shields.io/pypi/v/arrakis-server.svg" />
  </a>

</p>

---

## Installation

```
pip install arrakis-server
```

## Docker

```
docker run --net=host -it docker://containers.ligo.org/ngdd/arrakis-server:main
```

## Features

TODO

## Quickstart

1. Run `arrakis-server mock`.
2. Make client requests through the [Arrakis client library](https://git.ligo.org/ngdd/arrakis-python).
3. Shut down the server instance with Ctrl-C.
