-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Per #73, reorganized use case documentation and added templates for f…
…uture use (#74) * Per #73, reorganized use case documentation and added templates for future use. * Removing references to Generic CONUS interesting weather use case.
- Loading branch information
Showing
6 changed files
with
202 additions
and
17 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
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,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. |
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,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. |
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,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. |
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,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. |
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