Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GIScience/openrouteservice-examples
:books: (Mostly) real-world examples and inspirations to use the full breadth of ORS services and clients
https://github.com/GIScience/openrouteservice-examples
Last synced: 3 months ago
JSON representation
:books: (Mostly) real-world examples and inspirations to use the full breadth of ORS services and clients
- Host: GitHub
- URL: https://github.com/GIScience/openrouteservice-examples
- Owner: GIScience
- License: apache-2.0
- Created: 2018-03-26T20:36:57.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T11:31:07.000Z (4 months ago)
- Last Synced: 2024-11-22T04:51:41.973Z (3 months ago)
- Language: Jupyter Notebook
- Homepage: https://openrouteservice.org
- Size: 94.6 MB
- Stars: 88
- Watchers: 18
- Forks: 45
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jupyter examples to use openrouteservice
[](https://mybinder.org/v2/gh/GIScience/openrouteservice-examples/master?filepath=python)
(Mostly) real-world examples and inspirations to use the full range of ORS services and clients.
For an instant setup, you can use [MyBinder](https://mybinder.org/v2/gh/GIScience/openrouteservice-examples/master?filepath=python)
to start an interactive Jupyter server.
### Local installation
```bash
# clone the repo and enter folder
git clone https://github.com/GIScience/openrouteservice-examples.git
cd openrouteservice-examples
# Install the requirements in a virtual env and activate it
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
> Note: In case jupyter is already installed globally, and you want to use the local version, you can create a symlink to
> the local jupyter with:
>
>`ln -s .venv/bin/jupyter jupyter`
>
> Then, run jupyter commands with `./jupyter` instead.
### Launch the Jupyter server on the python directory
jupyter notebook python/
### Development
If you are not just using but editing or adding notebooks, you need to install the jupytext extension
```bash
# set up jupytext server extension, needs Jupyter Notebook 7 or later
jupyter labextension enable jupyterlab-jupytext
```
Note, that every notebook is paired with a corresponding `.py`-file of the same name.
On changing either the notebook or the `.py`-file, the other one will be automatically updated.
When reviewing changes, only the `.py`-file needs to be looked at, the
`.ipynb`-file is only kept for use with jupyter in the browser and to render
maps and other information.
### Pairing new notebooks
New notebooks have to be paired by clicking `File > Jupytext > Pair Notebook with Light Format`