Skip to content

Commit

Permalink
update installation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
nreinicke committed Oct 31, 2023
1 parent e63efbc commit 83881ff
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 10 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 83881ff

Please sign in to comment.