urbanopt-cli 0.6.2 → 0.7.1

data/example_files/resources/hpxml-measures/docs/source/build_residential_hpxml.rst

@@ -1,110 +0,0 @@
-BuildResidentialHPXML
-=====================
-
-The BuildResidentialHPXML measure builds a residential HPXML file.
-The HPXML file that it produces is intended to be the input for the HPXMLtoOpenStudio measure.
-
-Capabilities
-------------
-
-The following arguments are used to populate fields of the HPXML file:
-
-- Paths
-
-  - HPXML File
-  - Weather Directory
-
-- Software Program
-
-  - Name
-  - Version
-
-- Simulation Control
-
-  - Timestep
-  - Begin Month/Day
-  - End Month/Day
-  - Daylight Saving Begin Month/Day
-  - Daylight Saving End Month/Day
-
-- Schedules
-
-  - Type (Average, Stochastic, User-Specified)
-  - Path
-  - Vacancy Begin Month/Day
-  - Vacancy End Month/Day
-
-- Weather
-
-  - Station EPW Filename
-
-- Geometry
-
-  - Unit Type (manufactured home, single-family detached, single-family attached, apartment unit)
-  - Building Orientation (Number of Units, Horizontal/Vertical Level)
-
-- Enclosure
-
-  - Attics (Vented, Unvented, Conditioned)
-  - Foundations (Slab, Unconditioned Basement, Conditioned Basement, Vented Crawlspace, Unvented Crawlspace, Ambient)
-  - Garages
-  - Windows & Overhangs
-  - Skylights
-  - Doors
-  
-- HVAC
-
-  - Heating Systems (Electric Resistance, Furnaces, Wall/Floor Furnaces, Stoves, Boilers, Portable Heaters, Fireplaces)
-  - Cooling Systems (Central Air Conditioners, Room Air Conditioners, Evaporative Coolers)
-  - Heat Pumps (Air Source, Mini Split, Ground Source, Dual-Fuel)
-  - Dehumidifier
-  - Setpoints
-  - Ducts
-  
-- Water Heating
-
-  - Water Heaters (Storage, Tankless, Heat Pump, Indirect, Tankless Coil)
-  - Solar Hot Water
-  - Hot Water Distribution (Standard, Recirculation)
-  - Drain Water Heat Recovery
-  - Hot Water Fixtures
-  
-- Ventilation
-
-  - Mechanical Ventilation (Exhaust, Supply, Balanced, ERV, HRV, CFIS)
-  - Kitchen Fan
-  - Bathroom Fans
-  - Whole House Fan
-
-- Photovoltaics
-- Appliances (Clothes Washer/Dryer, Dishwasher, Refrigerator, Extra Refrigerator, Freezer, Cooking Range/Oven)
-- Lighting (Interior, Exterior, Garage, Holiday)
-- Ceiling Fans
-- Plug Loads (Other, TV, Well Pump, Vehicle)
-- Fuel Loads (Grill, Lighting, Fireplace)
-- Pool (Pump, Heater)
-- Hot Tub (Pump, Heater)
-
-Software Tools
---------------
-
-The following are software tools that currently use the OpenStudio-HPXML workflow for simulating residential buildings.
-
-ResStock™
-~~~~~~~~~
-
-ResStock uses a subset of all the capabilities of OpenStudio-HPXML:
-
-#. At most, one heating system and one cooling system can be simulated. This means that both a heating system and heat pump, or cooling system and heat pump, cannot be simulated.
-#. At most, one water heater can be simulated.
-#. Not supporting skylights adjacent to unconditioned space.
-#. Not supporting walkout basements.
-#. Not supporting DSE.
-#. Not supporting constant ACH infiltration.
-
-URBANopt
-~~~~~~~~
-
-URBANopt uses the same subset of capabilities as ResStock. However, there is more mapping/defaulting of argument values in URBANopt:
-
-#. TODO

data/example_files/resources/hpxml-measures/docs/source/getting_started.rst

@@ -1,57 +0,0 @@
-Getting Started
-===============
-
-Setup
------
-
-To get started:
-
-#. Download `OpenStudio 3.2.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.2.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
-#. Download the `latest release <https://github.com/NREL/OpenStudio-HPXML/releases>`_.
-
-Running
--------
-
-To programatically run simulations, it's recommended to use the OpenStudio `Command Line Interface <http://nrel.github.io/OpenStudio-user-documentation/reference/command_line_interface/>`_.
-Two general approaches (basic and advanced) for running via the CLI are described below.
-The OpenStudio measures can also be run from user interfaces (e.g., the OpenStudio Application or OpenStudio Parametric Analysis Tool (PAT)).
-
-.. note:: 
-
-  If the ``openstudio`` command is not found, it's because the executable is not in your PATH. Either add the executable to your PATH or point directly to the executable found in the openstudio-X.X.X/bin directory.
-
-Basic Run
-~~~~~~~~~
-
-The simplest and fastest method is to call the OpenStudio CLI with the provided ``workflow/run_simulation.rb`` script.
-
-For example:
-``openstudio workflow/run_simulation.rb -x workflow/sample_files/base.xml``
-
-This will create a "run" directory with all input/output files.
-By default it will be found at the same location as the input HPXML file.
-
-Run ``openstudio workflow/run_simulation.rb -h`` to see all available commands/arguments.
-
-Advanced Run
-~~~~~~~~~~~~
- 
-If additional flexibility is desired (e.g., specifying individual measure arguments, including additional OpenStudio measures to run alongside this measure in a workflow, etc.), create an `OpenStudio Workflow (OSW) <https://nrel.github.io/OpenStudio-user-documentation/reference/command_line_interface/#osw-structure>`_ file.
-The OSW is a JSON file that will specify all the OpenStudio measures (and their arguments) to be run sequentially.
-A template OSW that simply runs the HPXMLtoOpenStudio and SimulationOutputReport measures on the ``workflow/sample_files/base.xml`` file can be found at ``workflow/template.osw``.
-
-For example:
-``openstudio run -w workflow/template.osw``
-
-This will create a "run" directory with all input/output files.
-By default it will be found at the same location as the OSW file.
-
-Outputs
-~~~~~~~
-
-In addition to the standard EnergyPlus outputs found in the run directory, a variety of high-level annual outputs are conveniently reported in the resulting ``run/results_annual.csv`` (or ``run/results_annual.json``) file.
-
-Timeseries outputs can also be requested using either the Basic or Advanced approaches.
-When requested, timeseries outputs will be found in the ``run/results_timeseries.csv`` (or ``run/results_timeseries.json``) file.
-
-See :ref:`workflow_outputs` for a description of all available outputs available.