From 72af5a44ec6a2e39334594691e99c6da048e0251 Mon Sep 17 00:00:00 2001 From: Nicholas Reinicke Date: Mon, 24 Apr 2023 12:00:04 -0600 Subject: [PATCH] move the quick start to a markdown file for proper rendering --- docs/source/index.rst | 20 ++------------------ docs/source/quick_start.md | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 18 deletions(-) create mode 100644 docs/source/quick_start.md diff --git a/docs/source/index.rst b/docs/source/index.rst index a2e20f76..f1279fbc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 ` 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 diff --git a/docs/source/quick_start.md b/docs/source/quick_start.md new file mode 100644 index 00000000..2aa74278 --- /dev/null +++ b/docs/source/quick_start.md @@ -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!