Skip to content

Commit

Permalink
Per #73, reorganized use case documentation and added templates for f…
Browse files Browse the repository at this point in the history
…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
briannen authored Jan 27, 2025
1 parent f9c4574 commit dc1952f
Show file tree
Hide file tree
Showing 6 changed files with 202 additions and 17 deletions.
32 changes: 32 additions & 0 deletions docs/Users_Guide/airquality_usecase.rst
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.
32 changes: 32 additions & 0 deletions docs/Users_Guide/lulc_usecase.rst
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.
40 changes: 40 additions & 0 deletions docs/Users_Guide/matthew_usecase.rst
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.
32 changes: 32 additions & 0 deletions docs/Users_Guide/renewable_usecase.rst
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.
59 changes: 59 additions & 0 deletions docs/Users_Guide/use_case_template.rst
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.
24 changes: 7 additions & 17 deletions docs/Users_Guide/usecases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`

0 comments on commit dc1952f

Please sign in to comment.