Skip to content

Commit

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

Improve README
  • Loading branch information
lucas-bremond authored Jan 18, 2020
2 parents 2c291b2 + 547dae7 commit 76d270b
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 34 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,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
79 changes: 45 additions & 34 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-core)
[![GitHub version](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-core.svg)](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-core)
[![PyPI version](https://badge.fury.io/py/open-space-toolkit-core.svg)](https://badge.fury.io/py/open-space-toolkit-core)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-space-collective/open-space-toolkit-core/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)

Common types, containers and utilities.
Expand All @@ -14,69 +13,81 @@ Common types, containers and utilities.

*⚠ This component is under development.*

## Installation
## Getting Started

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

The binary packages are hosted using [GitHub Releases](https://github.com/open-space-collective/open-space-toolkit-core/releases).
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-space-collective/open-space-toolkit/master?urlpath=lab/tree/notebooks)

*Note: Don't forget to set the desired version number in the URLs!*
*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.*

#### Debian / Ubuntu
### Alternatives

```bash
# Download .deb packages
#### Docker Images

wget https://github.com/open-space-collective/open-space-toolkit-core/releases/download/0.3.0/open-space-toolkit-core-0.3.0-1.x86_64-runtime.deb
wget https://github.com/open-space-collective/open-space-toolkit-core/releases/download/0.3.0/open-space-toolkit-core-0.3.0-1.x86_64-devel.deb
[Docker](https://www.docker.com/) must be installed on your system.

# Install .deb packages
##### iPython

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

#### Fedora / CentOS
The following command will start an [iPython](https://ipython.org/) shell within a container where the OSTk components are already installed:

```bash
# Download .rpm packages
docker run -it openspacecollective/open-space-toolkit-core-python
```

wget https://github.com/open-space-collective/open-space-toolkit-core/releases/download/0.3.0/open-space-toolkit-core-0.3.0-1.x86_64-runtime.rpm
wget https://github.com/open-space-collective/open-space-toolkit-core/releases/download/0.3.0/open-space-toolkit-core-0.3.0-1.x86_64-devel.rpm
Once the shell is up and running, playing with it is easy:

# Install .rpm packages
```py
from ostk.core.filesystem import Directory # Directory class

dnf install -y open-space-toolkit-core-0.3.0-*.rpm
Directory.root().is_empty() # True if the root directory is empty
```

### Python
*Tip: Use tab for auto-completion!*

The binary packages are hosted on [PyPI](https://pypi.org/project/open-space-toolkit-core/):
##### 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
pip install open-space-toolkit-core
docker run --publish=8888:8888 openspacecollective/open-space-toolkit-core-jupyter
```

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

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

Install [Docker](https://www.docker.com/) and try this:
### 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
docker run -it openspacecollective/open-space-toolkit-core-python
apt install open-space-toolkit-core-*.deb
```

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

Once the shell is up and running, playing with it is easy:
#### Fedora / CentOS

```py
from ostk.core.filesystem import Directory # Directory class
After downloading the relevant `.rpm` binary packages, install:

Directory.root().is_empty() # True if the root directory is empty
```bash
dnf install open-space-toolkit-core-*.rpm
```

*Tip: Use tab for auto-completion!*
### Python

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

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

## Structure

Expand Down

0 comments on commit 76d270b

Please sign in to comment.