Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sceki authored Mar 18, 2024
1 parent dd503df commit 1fd963e
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
<!-- PROJECT LOGO -->
Expand Down Expand Up @@ -34,9 +36,24 @@ 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
## Installation

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.
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 .
```

## How to cite

Expand All @@ -52,6 +69,10 @@ $\partial \textrm{SGP4}$ and its applications for ML hybrid propagation and more
}
```

## 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/)
Expand Down

0 comments on commit 1fd963e

Please sign in to comment.