Skip to content

Commit 8a94a12

Browse files
Merge pull request #23 from open-space-collective/users/lucas/update-readme
Update README and remove notebooks (now part of main repo)
2 parents 7a4a501 + 80118da commit 8a94a12

File tree

7 files changed

+59
-66144
lines changed

7 files changed

+59
-66144
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,7 @@ deploy-release-image-jupyter: build-release-image-jupyter
592592
@ echo "Deploying Jupyter Notebook release image..."
593593

594594
docker push $(docker_release_image_jupyter_repository):$(docker_image_version)
595+
docker push $(docker_release_image_jupyter_repository):latest
595596

596597
deploy-packages:
597598

README.md

Lines changed: 58 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
[![Documentation](https://img.shields.io/readthedocs/pip/stable.svg)](https://open-space-collective.github.io/open-space-toolkit-astrodynamics)
66
[![GitHub version](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-astrodynamics.svg)](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-astrodynamics)
77
[![PyPI version](https://badge.fury.io/py/open-space-toolkit-astrodynamics.svg)](https://badge.fury.io/py/open-space-toolkit-astrodynamics)
8-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-space-collective/open-space-toolkit-astrodynamics/master?urlpath=lab/tree/tutorials%2Fpython%2Fnotebooks)
98
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
109

1110
Orbit, attitude, access.
@@ -16,60 +15,28 @@ Orbit, attitude, access.
1615

1716
*⚠ This component is under development.*
1817

19-
## Installation
20-
21-
### C++
22-
23-
The binary packages are hosted using [GitHub Releases](https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases).
24-
25-
*Note: Don't forget to set the desired version number in the URLs!*
26-
27-
#### Debian / Ubuntu
28-
29-
```bash
30-
# Download .deb packages
31-
32-
wget https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases/download/0.3.0/open-space-toolkit-astrodynamics-0.3.0-1.x86_64-runtime.deb
33-
wget https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases/download/0.3.0/open-space-toolkit-astrodynamics-0.3.0-1.x86_64-devel.deb
34-
35-
# Install .deb packages
36-
37-
apt install -y open-space-toolkit-astrodynamics-0.3.0-*.deb
38-
```
39-
40-
#### Fedora / CentOS
18+
## Getting Started
4119

42-
```bash
43-
# Download .rpm packages
20+
Want to get started? This is the simplest and quickest way:
4421

45-
wget https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases/download/0.3.0/open-space-toolkit-astrodynamics-0.3.0-1.x86_64-runtime.rpm
46-
wget https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases/download/0.3.0/open-space-toolkit-astrodynamics-0.3.0-1.x86_64-devel.rpm
22+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-space-collective/open-space-toolkit/master?urlpath=lab/tree/notebooks)
4723

48-
# Install .rpm packages
24+
*Nothing to download or install! This will automatically start a [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) environment in your browser with Open Space Toolkit libraries and example notebooks ready to use.*
4925

50-
dnf install -y open-space-toolkit-astrodynamics-0.3.0-*.rpm
51-
```
26+
### Alternatives
5227

53-
### Python
28+
#### Docker Images
5429

55-
The binary packages are hosted on [PyPI](https://pypi.org/project/open-space-toolkit-astrodynamics/):
30+
[Docker](https://www.docker.com/) must be installed on your system.
5631

57-
```bash
58-
pip install open-space-toolkit-astrodynamics
59-
```
32+
##### iPython
6033

61-
## Getting Started
62-
63-
Want to quickly get started? It's pretty simple.
64-
65-
Install [Docker](https://www.docker.com/) and try this:
34+
The following command will start an [iPython](https://ipython.org/) shell within a container where the OSTk components are already installed:
6635

6736
```bash
6837
docker run -it openspacecollective/open-space-toolkit-astrodynamics-python
6938
```
7039

71-
This will start an [iPython](https://ipython.org/) shell within a container where the OSTk Astrodynamics component is already installed.
72-
7340
Once the shell is up and running, playing with it is easy:
7441

7542
```py
@@ -91,8 +58,56 @@ orbit = Orbit(SGP4(tle), earth) # Construct orbit using SGP4 model
9158
orbit.get_state_at(Instant.now()) # Compute and display current satellite state (position, velocity)
9259
```
9360

61+
By default, OSTk fetches the ephemeris from JPL, Earth Orientation Parameters (EOP) and leap second count from IERS.
62+
63+
As a result, when running OSTk for the first time, it may take a minute to fetch all the necessary data.
64+
9465
*Tip: Use tab for auto-completion!*
9566

67+
##### JupyterLab
68+
69+
The following command will start a [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) server within a container where the OSTk components are already installed:
70+
71+
```bash
72+
docker run --publish=8888:8888 openspacecollective/open-space-toolkit-astrodynamics-jupyter
73+
```
74+
75+
Once the container is running, access [http://localhost:8888/lab](http://localhost:8888/lab) and create a Python 3 Notebook.
76+
77+
## Installation
78+
79+
### C++
80+
81+
The binary packages are hosted using [GitHub Releases](https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases):
82+
83+
- Runtime libraries: `open-space-toolkit-astrodynamics-X.Y.Z-1.x86_64-runtime`
84+
- C++ headers: `open-space-toolkit-astrodynamics-X.Y.Z-1.x86_64-devel`
85+
- Python bindings: `open-space-toolkit-astrodynamics-X.Y.Z-1.x86_64-python`
86+
87+
#### Debian / Ubuntu
88+
89+
After downloading the relevant `.deb` binary packages, install:
90+
91+
```bash
92+
apt install open-space-toolkit-astrodynamics-*.deb
93+
```
94+
95+
#### Fedora / CentOS
96+
97+
After downloading the relevant `.rpm` binary packages, install:
98+
99+
```bash
100+
dnf install open-space-toolkit-astrodynamics-*.rpm
101+
```
102+
103+
### Python
104+
105+
Install from [PyPI](https://pypi.org/project/open-space-toolkit-astrodynamics/):
106+
107+
```bash
108+
pip install open-space-toolkit-astrodynamics
109+
```
110+
96111
## Structure
97112

98113
The **Astrodynamics** library exhibits the following structure:
@@ -191,7 +206,7 @@ Or to run them manually:
191206
| 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) |
192207
| 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) |
193208
| 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) |
194-
| Physics | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-physics](https://github.com/open-space-collective/open-space-toolkit-physics) |
209+
| 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) |
195210

196211
## Contribution
197212

tutorials/python/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)