.. BuildStock Batch documentation master file, created by
   sphinx-quickstart on Mon Oct  1 14:27:44 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

BuildStock Batch
================

This set of tools provides a means to run and manage the batch simulations for
the `ResStock`_ and `ComStock`_ building stock energy modeling platforms. It can
be used to run the simulations locally, on NREL's high performance computers, or
Amazon Web Services (beta).

.. _ResStock: https://github.com/NREL/resstock
.. _ComStock: https://github.com/NREL/comstock

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   project_defn
   samplers/index
   workflow_generators/index
   filtering_logic
   run_sims


Updates & Changelog
===================

.. toctree::
   :maxdepth: 2
   :caption: Changes & Migration

   changelog/index

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`