diff --git a/README.md b/README.md index 0edb89a..5361613 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # $\partial\textrm{SGP4}$ [![build](https://github.com/esa/dSGP4/actions/workflows/build.yml/badge.svg)](https://github.com/esa/dSGP4/actions/workflows/build.yml) [![codecov](https://codecov.io/gh/esa/dSGP4/graph/badge.svg?token=K3py7YT8UR)](https://codecov.io/gh/esa/dSGP4) +[![Anaconda-Server Badge](https://anaconda.org/conda-forge/dsgp4/badges/latest_release_relative_date.svg)](https://anaconda.org/conda-forge/dsgp4) +[![Anaconda-Server Badge](https://anaconda.org/conda-forge/dsgp4/badges/downloads.svg)](https://anaconda.org/conda-forge/dsgp4) Differentiable SGP4. @@ -34,13 +36,9 @@ This repository contains the code discussed in [this paper](https://arxiv.org/ab * Parallel TLE propagation * Use of differentiable SGP4 on several spaceflight mechanics problems (state transition matrix computation, covariance transformation, and propagation, orbit determination, ML hybrid orbit propagation, etc.) -## Documentation and examples - -To get started, follow the examples in the [documentation](https://esa.github.io/dSGP4/). You will find tutorials with basic and more advanced functionalities and applications. - ## How to cite -If you use `dsgp4` and/or find it useful, we would be grateful if you could star the repository and/or cite our work. +If you use `dsgp4`, we would be grateful if you could star the repository and/or cite our work. $\partial \textrm{SGP4}$ and its applications for ML hybrid propagation and more, can be found in our [publication](https://arxiv.org/abs/2402.04830): ``` @@ -52,6 +50,29 @@ $\partial \textrm{SGP4}$ and its applications for ML hybrid propagation and more } ``` +## Installation + +Via [pip](https://pypi.org/project/dsgp4/): +``` +pip install dsgp4 +``` + +Via [conda](https://anaconda.org/conda-forge/dsgp4): +``` +conda install conda-forge::dsgp4 +``` + +Local installation: +``` +git clone https://github.com/esa/dSGP4.git +cd dSGP4 +pip install -e . +``` + +## Documentation and examples + +To get started, follow the examples in the [documentation](https://esa.github.io/dSGP4/). You will find tutorials with basic and more advanced functionalities and applications. + ## Authors: * [Giacomo Acciarini](https://www.esa.int/gsp/ACT/team/giacomo_acciarini/) * [Atılım Güneş Baydin](http://gbaydin.github.io/)