diff --git a/README.md b/README.md index 3159eff..f848761 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 } ) diff --git a/docs/installation.md b/docs/installation.md index f60ff1c..6db5ca0 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,4 +1,5 @@ # Installation +(In case `pip` is unavailable, use `pip3`) ## From PyPI @@ -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 diff --git a/rust/pyproject.toml b/rust/pyproject.toml index c10caf7..4b8de50 100644 --- a/rust/pyproject.toml +++ b/rust/pyproject.toml @@ -4,6 +4,7 @@ build-backend = "maturin" [project] name = "powertrain_rust" +version = "1.1.1" requires-python = ">=3.8" classifiers = [ "Programming Language :: Rust",