https://github.com/open-space-collective/open-space-toolkit-core
Common types, containers and utilities.
https://github.com/open-space-collective/open-space-toolkit-core
core cpp engineering python space toolkit
Last synced: about 1 year ago
JSON representation
Common types, containers and utilities.
- Host: GitHub
- URL: https://github.com/open-space-collective/open-space-toolkit-core
- Owner: open-space-collective
- License: apache-2.0
- Created: 2018-06-10T18:32:32.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-02-22T16:53:32.000Z (over 1 year ago)
- Last Synced: 2025-04-09T15:09:37.612Z (about 1 year ago)
- Topics: core, cpp, engineering, python, space, toolkit
- Language: C++
- Homepage: https://open-space-collective.github.io/open-space-toolkit-core/
- Size: 12.7 MB
- Stars: 20
- Watchers: 6
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Open Space Toolkit ▸ Core
[](https://github.com/open-space-collective/open-space-toolkit-core/actions/workflows/build-test.yml)
[](https://github.com/open-space-collective/open-space-toolkit-core/actions/workflows/release.yml)
[](https://codecov.io/gh/open-space-collective/open-space-toolkit-core)
[](https://open-space-collective.github.io/open-space-toolkit-core)
[](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-core)
[](https://badge.fury.io/py/open-space-toolkit-core)
[](https://opensource.org/licenses/Apache-2.0)
Common types, containers and utilities.
## Getting Started
Want to get started? This is the simplest and quickest way:
[](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-core-development python3.11 -m IPython
```
Once the shell is up and running, playing with it is easy:
```py
from ostk.core.filesystem import Directory # Directory class
Directory.root().is_empty() # True if the root directory is empty
```
*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-core-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-core/releases):
- Runtime libraries: `open-space-toolkit-core-X.Y.Z-1.x86_64-runtime`
- C++ headers: `open-space-toolkit-core-X.Y.Z-1.x86_64-devel`
- Python bindings: `open-space-toolkit-core-X.Y.Z-1.x86_64-python`
#### Debian / Ubuntu
After downloading the relevant `.deb` binary packages, install:
```bash
apt install open-space-toolkit-core-*.deb
```
### Python
Install from [PyPI](https://pypi.org/project/open-space-toolkit-core/):
```bash
pip install open-space-toolkit-core
```
## Documentation
Documentation is available [here](https://open-space-collective.github.io/open-space-toolkit-core):
## 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-core-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: The `ostk-build` command 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-core.test
```
*Tip: The `ostk-test` command simplifies running tests from within the development environment.*
## 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
[](https://www.loftorbital.com/)
## License
Apache License 2.0