forked from NREL/hive
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move the quick start to a markdown file for proper rendering
- Loading branch information
Showing
2 changed files
with
17 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |