Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/open-space-collective/open-space-toolkit-simulation

Spacecraft simulation.
https://github.com/open-space-collective/open-space-toolkit-simulation

cpp engineering python satellite simulation space spacecraft toolkit

Last synced: 2 months ago
JSON representation

Spacecraft simulation.

Host: GitHub
URL: https://github.com/open-space-collective/open-space-toolkit-simulation
Owner: open-space-collective
License: apache-2.0
Created: 2020-05-10T20:17:41.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-12-02T22:05:54.000Z (2 months ago)
Last Synced: 2024-12-02T23:19:54.674Z (2 months ago)
Topics: cpp, engineering, python, satellite, simulation, space, spacecraft, toolkit
Language: C++
Size: 8.23 MB
Stars: 10
Watchers: 7
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # Open Space Toolkit ▸ Simulation

[![Build and Test](https://github.com/open-space-collective/open-space-toolkit-simulation/actions/workflows/build-test.yml/badge.svg?branch=main)](https://github.com/open-space-collective/open-space-toolkit-simulation/actions/workflows/build-test.yml)

[![Code Coverage](https://codecov.io/gh/open-space-collective/open-space-toolkit-simulation/branch/main/graph/badge.svg)](https://codecov.io/gh/open-space-collective/open-space-toolkit-simulation)

[![Documentation](https://img.shields.io/readthedocs/pip/stable.svg)](https://open-space-collective.github.io/open-space-toolkit-simulation)

[![GitHub version](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-simulation.svg)](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-simulation)

[![PyPI version](https://badge.fury.io/py/open-space-toolkit-simulation.svg)](https://badge.fury.io/py/open-space-toolkit-simulation)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Spacecraft simulation.

*This library is still in draft state. Do not use!*

## Getting Started

Want to get started? This is the simplest and quickest way:

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-space-collective/open-space-toolkit/main?urlpath=lab/tree/notebooks)

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

### Alternatives

#### Docker Images

[Docker](https://www.docker.com/) must be installed on your system.

##### iPython

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-simulation-development python3.11 -m IPython

```

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

```py

# TBC...

```

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-simulation-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-simulation/releases):

- Runtime libraries: `open-space-toolkit-simulation-X.Y.Z-1.x86_64-runtime`

- C++ headers: `open-space-toolkit-simulation-X.Y.Z-1.x86_64-devel`

- Python bindings: `open-space-toolkit-simulation-X.Y.Z-1.x86_64-python`

#### Debian / Ubuntu

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

```bash

apt install open-space-toolkit-simulation-*.deb

```

### Python

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

```bash

pip install open-space-toolkit-simulation

```

## Documentation

Documentation is available here:

- [C++](https://open-space-collective.github.io/open-space-toolkit-simulation)

- [Python](./bindings/python/docs)

Structure



The library exhibits the following detailed and descriptive structure:

```txt

└── Satellite

```



## Tutorials

Tutorials are available here:

- [C++](./tutorials/cpp)

- [Python](./tutorials/python)

## Setup

### Development Environment

Using [Docker](https://www.docker.com) for development is recommended, to simplify the installation of the necessary build tools and dependencies.

Instructions on how to install Docker are available [here](https://docs.docker.com/install/).

To start the development environment:

```bash

make start-development

```

This will:

1. Build the `openspacecollective/open-space-toolkit-simulation-development` Docker image.

2. Create a development environment container with local source files and helper scripts mounted.

3. Start a `bash` shell from the `./build` working directory.

If installing Docker is not an option, you can manually install the development tools (GCC, CMake) and all required dependencies,

by following a procedure similar to the one described in the [Development Dockerfile](./docker/development/Dockerfile).

### Build

From the `./build` directory:

```bash

cmake ..

make

```

*Tip: `ostk-build` simplifies building from within the development environment.*

### Test

To start a container to build and run the tests:

```bash

make test

```

Or to run them manually:

```bash

./bin/open-space-toolkit-simulation.test

```

*Tip: `ostk-test` simplifies running tests from within the development environment.*

## Dependencies

| Name          | Version | License                | Link                                                                                                                                           |

| ------------- | ------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |

| Pybind11      | 2.12.0  | BSD-3-Clause           | [github.com/pybind/pybind11](https://github.com/pybind/pybind11)                                                                               |

| Core          | main    | 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           | main    | Apache License 2.0     | [github.com/open-space-collective/open-space-toolkit-io](https://github.com/open-space-collective/open-space-toolkit-io)                       |

| Mathematics   | main    | Apache License 2.0     | [github.com/open-space-collective/open-space-toolkit-mathematics](https://github.com/open-space-collective/open-space-toolkit-mathematics)     |

| Physics       | main    | Apache License 2.0     | [github.com/open-space-collective/open-space-toolkit-physics](https://github.com/open-space-collective/open-space-toolkit-physics)             |

| Astrodynamics | main    | Apache License 2.0     | [github.com/open-space-collective/open-space-toolkit-astrodynamics](https://github.com/open-space-collective/open-space-toolkit-astrodynamics) |

## Contribution

Contributions are more than welcome!

Please read our [contributing guide](CONTRIBUTING.md) to learn about our development process, how to propose fixes and improvements, and how to build and test the code.

## Special Thanks

[![Loft Orbital](https://github.com/open-space-collective/open-space-toolkit/blob/main/assets/thanks/loft_orbital.png)](https://www.loftorbital.com/)

## License

Apache License 2.0