Metadata-Version: 2.1
Name: nsstools
Version: 0.1.3
Summary: Tools for calculate campbell and covmat from Gaia CU4 sources
Home-page: https://gitlab.obspm.fr/gaia/nsstools.git
Author: Nicolas Leclerc, Carine Babusiaux, Jean-Louis Halbwachs
Author-email: gaia.project@obspm.fr
License: CeCILL-2.1
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# nsstools
This python tools has two methods that applies on nss_two_body_orbit [Gaia DR3](https://www.cosmos.esa.int/web/gaia/data-release-3) solutions
- covmat: for all kind of nss_solution_type, converts the correlation matrix+uncertainties to the covariance matrix of the solution
- campbell: for a NSS solution that is either astrometric Orbital* or AstroSpectroSB1, converts the Thiele-Innes orbital elements to the Campbell elements and propagates the uncertainties.
            Ref: Halbwachs et al., 2022, Gaia Data Release 3. Astrometric binary star processing, Astronomy and Astrophysics, Appendix A
input: dataframe 
output: dataframe

A R version is available [here](https://gricad-gitlab.univ-grenoble-alpes.fr/babusiac/nsstools/).

## Installation

### with pip
pip3 install --user nsstools

### with setup
python3 setup.py install

## Usage

```python3
import pandas as pd
from nsstools import NssSource

nss = pd.read_csv("tests/data/nss_two_body_orbit_sample.csv.gz")
source_index = 0 # position of the source in the csv file

source = NssSource(nss, indice=source_index)
print(source.covmat())
print(source.campbell())

```

## Authors and acknowledgment
Authors:  Nicolas Leclerc from a code by Jean-Louis Halbwachs and Carine Babusiaux.
Reference: Halbwachs et al., 2022, Gaia Data Release 3. Astrometric binary star processing, Astronomy and Astrophysics, Appendix A and B.
R version: https://gricad-gitlab.univ-grenoble-alpes.fr/babusiac/nsstools/


