Per #73, reorganized use case documentation and added templates for future use

docs/Users_Guide/airquality_usecase.rst

@@ -0,0 +1,32 @@
+:orphan:
+
+.. _airqualityusecase:
+
+******************
+Air Quality Change
+******************
+
+Scientific Objective
+====================
+
+Update section content to describe the scientific objective of this use case.
+
+Version Added
+=============
+
+Update section with the version of i-wrf this use case was added to.
+
+Datasets
+========
+
+Update section content to describe the datasets used to run WRF and METplus.
+
+To Run
+======
+
+Running on SYSTEM NAME
+----------------------
+
+Update section with links to the documentation describing how to run on specific systems.
+
+See :ref:`usecasetemplate` for how to set up run documentation.

docs/Users_Guide/lulc_usecase.rst

@@ -0,0 +1,32 @@
+:orphan:
+
+.. _lulcusecase:
+
+**************************
+Land Use/Land Cover Change
+**************************
+
+Scientific Objective
+====================
+
+Update section content to describe the scientific objective of this use case.
+
+Version Added
+=============
+
+Update section with the version of i-wrf this use case was added to.
+
+Datasets
+========
+
+Update section content to describe the datasets used to run WRF and METplus.
+
+To Run
+======
+
+Running on SYSTEM NAME
+----------------------
+
+Update section with links to the documentation describing how to run on specific systems.
+
+See :ref:`usecasetemplate` for how to set up run documentation.

docs/Users_Guide/matthew_usecase.rst

@@ -0,0 +1,40 @@
+:orphan:
+
+.. _matthewusecase:
+
+*****************
+Hurricane Matthew
+*****************
+
+Scientific Objective
+====================
+
+Update section content to describe the scientific objective of this use case.
+
+Version Added
+=============
+
+Update section with the version of i-wrf this use case was added to.
+
+Datasets
+========
+
+Update section content to describe the datasets used to run WRF and METplus.
+
+To Run
+======
+
+Running on Jetstream2
+---------------------
+
+Navigate to :ref:`matthewjetstream` for more information.
+
+Running on Red Cloud
+--------------------
+
+Navigate to :ref:`matthewredcloud` for more information.
+
+Running on Windows with Intel Processor
+---------------------------------------
+
+Navigate to :ref:`matthewwindows` for more information.

docs/Users_Guide/renewable_usecase.rst

@@ -0,0 +1,32 @@
+:orphan:
+
+.. _renewableusecase:
+
+*************************
+Renewable Energy Droughts
+*************************
+
+Scientific Objective
+====================
+
+Update section content to describe the scientific objective of this use case.
+
+Version Added
+=============
+
+Update section with the version of i-wrf this use case was added to.
+
+Datasets
+========
+
+Update section content to describe the datasets used to run WRF and METplus.
+
+To Run
+======
+
+Running on SYSTEM NAME
+----------------------
+
+Update section with links to the documentation describing how to run on specific systems.
+
+See :ref:`usecasetemplate` for how to set up run documentation.

docs/Users_Guide/use_case_template.rst

@@ -0,0 +1,59 @@
+:orphan:
+
+.. _usecasetemplate:
+
+*****************
+Use Case Template
+*****************
+
+Overview
+========
+
+Update section with an overview of the following instructions.
+
+Prepare to Use SYSTEM NAME
+==========================
+
+Update section with instructions on how to set up the system to run i-wrf.
+
+Examples include:
+
+* Gaining access to the system
+* Creating instances
+* Managing instances.
+
+Preparing the Environment
+=========================
+
+Update section with instructions on how to prepare the environment to run.
+
+Examples include:
+
+* Define environment variables
+* Create run directories
+* Download configuration files
+
+Install Docker and Pull Docker Objects
+======================================
+
+Update section with instructions on how to install Docker and pull docker images needed.
+
+Download Data for WRF
+=====================
+
+Update section with instructions on how to download the data needed to run WRF.
+
+Run WRF
+=======
+
+Update section with instructions on how to run WRF.
+
+Run METplus
+===========
+
+Update section with instructions on how to run METplus.
+
+Visualize the Results
+=====================
+
+In the near future, this exercise will be extended to include instructions to visualize the results.

docs/Users_Guide/usecases.rst

@@ -2,32 +2,22 @@
 Use Cases
 *********
 
-Generic CONUS “interesting weather”
-===================================
-
 Hurricane Matthew
 =================
 
-Running on Jetstream2
----------------------
-
-Navigate to :ref:`matthewjetstream` for more information.
-
-Running on Red Cloud
---------------------
-
-Navigate to :ref:`matthewredcloud` for more information.
-
-Running on Windows with Intel Processor
----------------------------------------
-
-Navigate to :ref:`matthewwindows` for more information.
+:ref:`matthewusecase`
 
 Land Use/Land Cover Change
 ==========================
 
+:ref:`lulcusecase`
+
 Renewable Energy Droughts
 =========================
 
+:ref:`renewableusecase`
+
 Air Quality Change
 ==================
+
+:ref:`airqualityusecase`