Skip to content

Commit

Permalink
Merge pull request #25 from open-space-collective:users/lucas/update-…
Browse files Browse the repository at this point in the history
…readme

Update README
  • Loading branch information
lucas-bremond authored Jan 21, 2020
2 parents c6891ad + 585107b commit c07f393
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 79 deletions.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,18 @@ Install from [PyPI](https://pypi.org/project/open-space-toolkit-astrodynamics/):
pip install open-space-toolkit-astrodynamics
```

## Structure
## Documentation

Documentation is available here:

- [C++](https://open-space-collective.github.io/open-space-toolkit-astrodynamics)
- [Python](./bindings/python/docs)

<details>
<summary>Structure</summary>
<p>

The **Astrodynamics** library exhibits the following structure:
The library exhibits the following structure:

```txt
├── Trajectory
Expand All @@ -132,12 +141,8 @@ The **Astrodynamics** library exhibits the following structure:
└── State Profile
```

## Documentation

Documentation is available here:

- [C++](https://open-space-collective.github.io/open-space-toolkit-astrodynamics)
- [Python](./bindings/python/docs)
</p>
</details>

## Tutorials

Expand Down Expand Up @@ -197,16 +202,16 @@ Or to run them manually:

## Dependencies

| Name | Version | License | Link |
|-------------|---------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| Boost | 1.69.0 | Boost Software License | [boost.org](https://www.boost.org) |
| Eigen | 3.3.7 | MPL2 | [eigen.tuxfamily.org](http://eigen.tuxfamily.org/index.php) |
| SGP4 | master | Apache License 2.0 | [github.com/dnwrnr/sgp4](https://github.com/dnwrnr/sgp4) |
| NLopt | master | LGPL | [github.com/stevengj/nlopt](https://github.com/stevengj/nlopt) |
| Core | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-core](https://github.com/open-space-collective/open-space-toolkit-core) |
| I/O | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-io](https://github.com/open-space-collective/open-space-toolkit-io) |
| Mathematics | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-mathematics](https://github.com/open-space-collective/open-space-toolkit-mathematics) |
| Physics | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-astrodynamics](https://github.com/open-space-collective/open-space-toolkit-astrodynamics) |
| Name | Version | License | Link |
| ----------- | ------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Boost | 1.69.0 | Boost Software License | [boost.org](https://www.boost.org) |
| Eigen | 3.3.7 | MPL2 | [eigen.tuxfamily.org](http://eigen.tuxfamily.org/index.php) |
| SGP4 | master | Apache License 2.0 | [github.com/dnwrnr/sgp4](https://github.com/dnwrnr/sgp4) |
| NLopt | master | LGPL | [github.com/stevengj/nlopt](https://github.com/stevengj/nlopt) |
| Core | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-core](https://github.com/open-space-collective/open-space-toolkit-core) |
| I/O | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-io](https://github.com/open-space-collective/open-space-toolkit-io) |
| Mathematics | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-mathematics](https://github.com/open-space-collective/open-space-toolkit-mathematics) |
| Physics | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-astrodynamics](https://github.com/open-space-collective/open-space-toolkit-astrodynamics) |

## Contribution

Expand Down
14 changes: 0 additions & 14 deletions binder/postBuild

This file was deleted.

19 changes: 0 additions & 19 deletions binder/requirements.txt

This file was deleted.

12 changes: 0 additions & 12 deletions binder/runtime.txt

This file was deleted.

16 changes: 0 additions & 16 deletions binder/start

This file was deleted.

0 comments on commit c07f393

Please sign in to comment.