Skip to content

Commit

Permalink
move the quick start to a markdown file for proper rendering
Browse files Browse the repository at this point in the history
  • Loading branch information
nreinicke committed Apr 24, 2023
1 parent 87d0f04 commit 72af5a4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 18 deletions.
20 changes: 2 additions & 18 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,10 @@ HIVE supports researchers who explore Electric Vehicle (EV) fleet control, Elect
Out-of-the-box, it provides a baseline set of algorithms for fleet dispatch, but provides a testbed for exploring alternatives from leading research in model-predictive control (MPC) and deep reinforcement learning.
HIVE is designed to integrate with vehicle power and energy grid power models in real-time for accurate, high-fidelity energy estimation over arbitrary road networks and demand scenarios.

Quickstart
----------

You can install hive with `pip install nrel.hive`
(see the `README <https://github.com/NREL/hive>` for more detailed instructions)

HIVE is typically run using the command line interface (CLI) by calling the `hive` command.
For example, you can run either of the pre-packaged scenarios with `hive denver_demo.yaml` or `hive manhattan.yaml`.

The model takes in a single configuration file that specifies everything that makes up a single simulation (see the inputs page).

When the simulation is run (`hive denver_demo.yaml` for example), the model will write several output files that describe what happened during the simulation (see the outputs page).

You can also use hive as library for co-simulation or to implement custom control logic (see the customize page).

Lastly, if you're interested in contributing, checkout the developer page!

.. toctree::
:maxdepth: 1


quick_start
example
inputs
outputs
Expand Down
15 changes: 15 additions & 0 deletions docs/source/quick_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Quick Start

You can install hive with `pip install nrel.hive`
(see the [README](https://github.com/NREL/hive) for more detailed instructions)

HIVE is typically run using the command line interface (CLI) by calling the `hive` command.
For example, you can run either of the pre-packaged scenarios with `hive denver_demo.yaml` or `hive manhattan.yaml`.

The model takes in a single configuration file that specifies everything that makes up a single simulation (see the inputs page).

When the simulation is run (`hive denver_demo.yaml` for example), the model will write several output files that describe what happened during the simulation (see the outputs page).

You can also use hive as library for co-simulation or to implement custom control logic (see the customize page).

Lastly, if you're interested in contributing, checkout the developer page!

0 comments on commit 72af5a4

Please sign in to comment.