From 83881ff2c7feec8f03f13dcb05310648d03d708d Mon Sep 17 00:00:00 2001 From: Nicholas Reinicke Date: Tue, 31 Oct 2023 13:49:41 -0600 Subject: [PATCH] update installation instruction --- README.md | 2 +- docs/installation.md | 14 ++++++++++---- docs/intro.md | 2 +- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1af9be3b..1ab986ef 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ RouteE Compass is a part of the [RouteE](https://www.nrel.gov/transportation/rou - via [rust-lang.org](https://www.rust-lang.org/tools/install) - via [conda](https://anaconda.org/conda-forge/rust) 2. install RouteE Compass - - for Python via [pip](https://pypi.org/project/pip/): `$ pip install nrel.routee.compass[all]` + - for Python via [pip](https://pypi.org/project/pip/): `$ pip install 'nrel.routee.compass[all]'` - for the command line: `$ cd rust; cargo build -r` ## Usage diff --git a/docs/installation.md b/docs/installation.md index 3c1ce4bd..8bccaf6c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -10,12 +10,18 @@ You can install this package from PyPI using pip: pip install nrel.routee.compass ``` +Or, if you want plotting and OSM features: + +```bash +pip install 'nrel.routee.compass[all]' +``` + ### from source You can also install from source by running the following from the root folder of this repository: ```bash -pip install . +pip install '.[all]' ``` ## rust @@ -43,17 +49,17 @@ conda activate routee-compass Building the application from source can be done using `cargo`: ```bash -git clone https://github.nrel.gov/MBAP/routee-compass.git +git clone https://github.com/NREL/routee-compass.git cd routee-compass/rust cargo build --release ``` -This will build the application into the location `path/to/routee-compass/rust/target/release/compass-app` +This will build the application into the location `path/to/routee-compass/rust/target/release/routee-compass` You can optionally alias the application to make it easier to run: ```bash -alias compass-app=path/to/routee-compass/rust/target/release/compass-app +alias compass-app=path/to/routee-compass/rust/target/release/routee-compass ``` diff --git a/docs/intro.md b/docs/intro.md index 99bba79c..db0079c6 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -11,7 +11,7 @@ RouteE Compass is an energy-aware routing engine for the RouteE ecosystem of sof The fastest way to get started with RouteE Compass is to use the python package manager `pip`: ```bash -pip install nrel.routee.compass[osm] +pip install 'nrel.routee.compass[all]' ``` Then, follow this [example](notebooks/open_street_maps_example.ipynb) to start routing over Open Street Maps data.