Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme instructions #30

Merged
merged 5 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ pip install pip --upgrade
pip install nrel.routee.powertrain
```

If `pip` is unavailable, use `pip3`:
```bash
pip3 install pip --upgrade
pip3 install nrel.routee.powertrain
```

(For more detailed instructions, see [here](https://nrel.github.io/routee-powertrain/installation.html))

Then, you can import the package and use a pre-trained model from the RouteE model catalog:
Expand Down Expand Up @@ -80,9 +86,9 @@ print(model)
# Predict energy consumption for a set of road links
links_df = pd.DataFrame(
{
"miles": [0.1, 0.2, 0.3], # miles
"distance": [0.1, 0.2, 0.3], # miles
"speed_mph": [30, 40, 50], # mph
"grade_dec": [-0.05, 0, 0.05], # decimal
"grade_percent": [-0.5, 0, 0.5], # percent
}
)

Expand Down
11 changes: 10 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Installation
(In case `pip` is unavailable, use `pip3`)

## From PyPI

Expand Down Expand Up @@ -38,7 +39,15 @@ This should support usage of the following trainers:
### Rust Smartcore

The rust smartcore training pipeline requires a rust compiler to be installed on your system.
One way to do this is to use Anaconda:
One way to do this is to use [Anaconda](https://docs.anaconda.com/anaconda/install/):

Create a conda virtual environment as `routee`:

```bash
conda create --name routee
conda init
conda activate routee
```

```bash
conda install rust
Expand Down
1 change: 1 addition & 0 deletions rust/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ build-backend = "maturin"

[project]
name = "powertrain_rust"
version = "1.1.1"
requires-python = ">=3.8"
classifiers = [
"Programming Language :: Rust",
Expand Down
Loading