Skip to content

Commit

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

Update README and remove notebooks (now part of main repo)
  • Loading branch information
lucas-bremond authored Jan 18, 2020
2 parents 7a4a501 + 80118da commit 8a94a12
Show file tree
Hide file tree
Showing 7 changed files with 59 additions and 66,144 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,7 @@ deploy-release-image-jupyter: build-release-image-jupyter
@ echo "Deploying Jupyter Notebook release image..."

docker push $(docker_release_image_jupyter_repository):$(docker_image_version)
docker push $(docker_release_image_jupyter_repository):latest

deploy-packages:

Expand Down
101 changes: 58 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
[![Documentation](https://img.shields.io/readthedocs/pip/stable.svg)](https://open-space-collective.github.io/open-space-toolkit-astrodynamics)
[![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)
[![PyPI version](https://badge.fury.io/py/open-space-toolkit-astrodynamics.svg)](https://badge.fury.io/py/open-space-toolkit-astrodynamics)
[![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)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Orbit, attitude, access.
Expand All @@ -16,60 +15,28 @@ Orbit, attitude, access.

*⚠ This component is under development.*

## Installation

### C++

The binary packages are hosted using [GitHub Releases](https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases).

*Note: Don't forget to set the desired version number in the URLs!*

#### Debian / Ubuntu

```bash
# Download .deb packages

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

# Install .deb packages

apt install -y open-space-toolkit-astrodynamics-0.3.0-*.deb
```

#### Fedora / CentOS
## Getting Started

```bash
# Download .rpm packages
Want to get started? This is the simplest and quickest way:

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
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
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-space-collective/open-space-toolkit/master?urlpath=lab/tree/notebooks)

# Install .rpm packages
*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.*

dnf install -y open-space-toolkit-astrodynamics-0.3.0-*.rpm
```
### Alternatives

### Python
#### Docker Images

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

```bash
pip install open-space-toolkit-astrodynamics
```
##### iPython

## Getting Started

Want to quickly get started? It's pretty simple.

Install [Docker](https://www.docker.com/) and try this:
The following command will start an [iPython](https://ipython.org/) shell within a container where the OSTk components are already installed:

```bash
docker run -it openspacecollective/open-space-toolkit-astrodynamics-python
```

This will start an [iPython](https://ipython.org/) shell within a container where the OSTk Astrodynamics component is already installed.

Once the shell is up and running, playing with it is easy:

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

By default, OSTk fetches the ephemeris from JPL, Earth Orientation Parameters (EOP) and leap second count from IERS.

As a result, when running OSTk for the first time, it may take a minute to fetch all the necessary data.

*Tip: Use tab for auto-completion!*

##### JupyterLab

The following command will start a [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) server within a container where the OSTk components are already installed:

```bash
docker run --publish=8888:8888 openspacecollective/open-space-toolkit-astrodynamics-jupyter
```

Once the container is running, access [http://localhost:8888/lab](http://localhost:8888/lab) and create a Python 3 Notebook.

## Installation

### C++

The binary packages are hosted using [GitHub Releases](https://github.com/open-space-collective/open-space-toolkit-astrodynamics/releases):

- Runtime libraries: `open-space-toolkit-astrodynamics-X.Y.Z-1.x86_64-runtime`
- C++ headers: `open-space-toolkit-astrodynamics-X.Y.Z-1.x86_64-devel`
- Python bindings: `open-space-toolkit-astrodynamics-X.Y.Z-1.x86_64-python`

#### Debian / Ubuntu

After downloading the relevant `.deb` binary packages, install:

```bash
apt install open-space-toolkit-astrodynamics-*.deb
```

#### Fedora / CentOS

After downloading the relevant `.rpm` binary packages, install:

```bash
dnf install open-space-toolkit-astrodynamics-*.rpm
```

### Python

Install from [PyPI](https://pypi.org/project/open-space-toolkit-astrodynamics/):

```bash
pip install open-space-toolkit-astrodynamics
```

## Structure

The **Astrodynamics** library exhibits the following structure:
Expand Down Expand Up @@ -191,7 +206,7 @@ Or to run them manually:
| 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-physics](https://github.com/open-space-collective/open-space-toolkit-physics) |
| 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
Empty file added tutorials/python/.gitkeep
Empty file.
Loading

0 comments on commit 8a94a12

Please sign in to comment.