Metadata-Version: 2.1
Name: lisaorbits
Version: 2.2
Summary: LISA Orbits generates orbit files containing spacecraft positions and velocities, proper pseudo-ranges, and spacecraft proper times.
Home-page: https://gitlab.in2p3.fr/lisa-simulation/orbits
Author: Jean-Baptiste Bayle
Author-email: j2b.bayle@gmail.com
License: BSD-3-Clause
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# LISA Orbits

[![pipeline status](https://gitlab.in2p3.fr/lisa-simulation/orbits/badges/master/pipeline.svg)](https://gitlab.in2p3.fr/lisa-simulation/orbits/-/commits/master)
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.6412992.svg)](https://doi.org/10.5281/zenodo.6412992)


LISA Orbits is a Python package which generates orbit files compatible with [LISA Instrument](https://gitlab.in2p3.fr/lisa-simulation/instrument), [LISA GW Response](https://gitlab.in2p3.fr/lisa-simulation/orbits), the [LDC Software](https://lisa-ldc.lal.in2p3.fr/code), and [LISANode](https://gitlab.in2p3.fr/j2b.bayle/LISANode). Among others, an orbit file contains the spacecraft state vectors, the light travel times and the proper pseudoranges.

* **Documentation for the latest stable release is available at <https://lisa-simulation.pages.in2p3.fr/orbits>**
* Documentation for the current development version is available at <https://lisa-simulation.pages.in2p3.fr/orbits/master>

## Contributing

### Report an issue

We use the issue-tracking management system associated with the project provided by Gitlab. If you want to report a bug or request a feature, open an issue at <https://gitlab.in2p3.fr/lisa-simulation/orbits/-/issues>. You may also thumb-up or comment on existing issues.

### Development environment

We strongly recommend to use [Python virtual environments](https://docs.python.org/3/tutorial/venv.html).

To setup the development environment, use the following commands:

```shell
git clone git@gitlab.in2p3.fr:lisa-simulation/orbits.git
cd orbits
python -m venv .
source ./bin/activate
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
python -m pip install -e .
```

### Workflow

The project's development workflow is based on the issue-tracking system provided by Gitlab, as well as peer-reviewed merge requests. This ensures high-quality standards.

Issues are solved by creating branches and opening merge requests. Only the assignee of the related issue and merge request can push commits on the branch. Once all the changes have been pushed, the "draft" specifier on the merge request is removed, and the merge request is assigned to a reviewer. He can push new changes to the branch, or request changes to the original author by re-assigning the merge request to them. When the merge request is accepted, the branch is merged onto master, deleted, and the associated issue is closed.

### Pylint and unittest

We enforce [PEP 8 (Style Guide for Python Code)](https://www.python.org/dev/peps/pep-0008/) with Pylint syntax checking, and correction of the code using the pytest testing framework. Both are implemented in the continuous integration system.

You can run them locally

```shell
pylint lisaorbits/*.py
python -m pytest
```

## Use policy

There are currently no licenses associated with this project. However, we would like to foster open science in our community and share common tools. To this end, **we are making LISA Orbits available for full members of the [LISA Consortium](https://www.elisascience.org) to use in their research free of charge**.

However, please keep in mind that developing and maintaining such a tool takes time and effort. Therefore, we would appreciate to be associated with you research.

* Please cite the DOI (see badge above) and acknowledge the authors (below) in any publication
* Do not hesitate to send an email for support and collaboration

## Authors

* Jean-Baptiste Bayle (j2b.bayle@gmail.com)
* Aurélien Hees (aurelien.hees@obspm.fr)
* Marc Lilley (marc.lilley@obspm.fr)
* Christophe Le Poncin-Lafitte (christophe.leponcin@obspm.fr)
* Waldemar Martens (waldemar.martens@esa.int)
* Eric Joffre (eric.joffre@esa.int)
