Skip to content

Commit

Permalink
Merge branch 'develop' into feature_240_tcmpr
Browse files Browse the repository at this point in the history
  • Loading branch information
TatianaBurek committed Feb 27, 2023
2 parents f276c02 + 19a842e commit fcd8ed7
Show file tree
Hide file tree
Showing 72 changed files with 67 additions and 66 deletions.
4 changes: 1 addition & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
name: Bug report
about: Fix something that's not working
title: ''

title: 'Bugfix'
labels: 'alert: NEED ACCOUNT KEY, alert: NEED MORE DEFINITION, alert: NEED PROJECT ASSIGNMENT, type: bug'

assignees: ''

---
Expand Down
2 changes: 1 addition & 1 deletion docs/Users_Guide/bar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Run from the Command Line
The **custom_bar.yaml** configuration file, in combination with the
**bar_defaults.yaml** configuration file, generates a bar plot:

.. image:: bar.png
.. image:: figure/bar.png

To generate the above bar plot, perform the following:

Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ Perform the following to generate the plots:
**box_defaults.yaml** configuration file, generates a customized
box plot:

.. image:: box.png
.. image:: figure/box.png

To generate the above plot using the **box_defaults.yaml** and
**custom_box.yaml** config files, perform the following:
Expand All @@ -242,7 +242,7 @@ Perform the following to generate the plots:
template/starting point for setting up the margins, plot size, labels, etc.
and does not plot any data**:

.. image:: box_default.png
.. image:: figure/box_default.png

To generate the above *"defaults"* plot (i.e using default configuration
settings), use the "minimal" custom configuration file, **minimal_box.yaml**.
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/contour.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For more information on Contour plots, please refer to the



.. image:: contour.png
.. image:: figure/contour.png

Example
=======
Expand Down Expand Up @@ -191,7 +191,7 @@ perform the following:
in the directory that was specified in the *plot_filename*
setting of the **custom_contour.yaml** config file:

.. image:: contour.png
.. image:: figure/contour.png

* A **contour.png** output file will be created in
the directory that was specified in the *plot_filename* config setting
Expand Down
12 changes: 6 additions & 6 deletions docs/Users_Guide/difficulty_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,30 +129,30 @@ difficulty index and statistics plots:

**swh_North_Pacific_5dy_mean.png**:

.. image:: swh_North_Pacific_5dy_mean.png
.. image:: figure/swh_North_Pacific_5dy_mean.png

**swh_North_Pacific_5dy_std.png**:

.. image:: swh_North_Pacific_5dy_std.png
.. image:: figure/swh_North_Pacific_5dy_std.png

**"Difficulty Index" Plots**

**swh_North_Pacific_difficulty_index_10_00_feet.png**:

.. image:: swh_North_Pacific_difficulty_index_10_00_feet.png
.. image:: figure/swh_North_Pacific_difficulty_index_10_00_feet.png

**swh_North_Pacific_difficulty_index_11_00_feet.png**:

.. image:: swh_North_Pacific_difficulty_index_11_00_feet.png
.. image:: figure/swh_North_Pacific_difficulty_index_11_00_feet.png


**swh_North_Pacific_difficulty_index_12_00_feet.png**:

.. image:: swh_North_Pacific_difficulty_index_12_00_feet.png
.. image:: figure/swh_North_Pacific_difficulty_index_12_00_feet.png

**swh_North_Pacific_difficulty_index_9_00_feet.png**:

.. image:: swh_North_Pacific_difficulty_index_9_00_feet.png
.. image:: figure/swh_North_Pacific_difficulty_index_9_00_feet.png



Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/eclv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For more information on Economic Cost/Loss Value Plots, please refer to the
The ECLV score can range from -:math:`\infty` to 1.


.. image:: custom_eclv.png
.. image:: figure/custom_eclv.png

Example
=======
Expand Down Expand Up @@ -198,5 +198,5 @@ perform the following:
in the directory that was specified in the *plot_filename*
setting of the **custom_eclv.yaml** config file:

.. image:: custom_eclv.png
.. image:: figure/custom_eclv.png

2 changes: 1 addition & 1 deletion docs/Users_Guide/ens_ss.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Run from the Command Line
The **custom_ens_ss.yaml** configuration file, in combination with the
**ens_ss_defaults.yaml** configuration file, generates the following plot:

.. image:: ens_ss.png
.. image:: figure/ens_ss.png

Perform the following:

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
10 changes: 5 additions & 5 deletions docs/Users_Guide/fv3_physics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,15 +206,15 @@ Generate a plan view of all tendencies at 500 hPa:
python planview_fv3.py $CONFIG $WORKING_DIR/fv3_history.nc $WORKING_DIR/grid_spec.nc tmp pbl -p 500 -t 1 -v 20190504T14 --nofineprint
.. image:: tmp_500hPa.png
.. image:: figure/tmp_500hPa.png

Generate a plan view of PBL tendency at default pressure levels:

.. code-block:: bash
python planview_fv3.py $CONFIG $WORKING_DIR/fv3_history.nc $WORKING_DIR/grid_spec.nc tmp pbl -t 1 -v 20190504T13 --nofineprint
.. image:: tmp_pbl.png
.. image:: figure/tmp_pbl.png

.. code-block:: bash
Expand Down Expand Up @@ -258,7 +258,7 @@ Generate vertical profile of temperature tendencies averaged over the mid-CONUS
python vert_profile_fv3.py $CONFIG $WORKING_DIR/fv3_history.nc $WORKING_DIR/grid_spec.nc tmp -t 2 -v 20190504T14 -s $METPLOTPY_BASE/metplotpy/contributed/fv3_physics_tend/shapefiles/MID_CONUS --nofineprint
.. image:: tmp.vert_profile.MID_CONUS.png
.. image:: figure/tmp.vert_profile.MID_CONUS.png

Vertical cross section
______________________
Expand Down Expand Up @@ -307,7 +307,7 @@ Generate vertical cross section from 32°N 115°W to 34°N 82°W:
python cross_section_vert.py $CONFIG $WORKING_DIR/fv3_history.nc $WORKING_DIR/grid_spec.nc tmp -t 2 -v 20190504T14 -s 32 -115 -e 34 -82 --nofineprint
.. image:: tmp_32.0N-115.0E-34.0N-82.0E.png
.. image:: figure/tmp_32.0N-115.0E-34.0N-82.0E.png

Difference plot
_______________
Expand All @@ -319,5 +319,5 @@ Put file you want to subtract after the --subtract argument:
python vert_profile_fv3.py $CONFIG $WORKING_DIR/fv3_history.nc $WORKING_DIR/grid_spec.nc tmp -t 1 --subtract $WORKING_DIR/fv3_history.nc --nofineprint
.. image:: tmp.vert_profile.png
.. image:: figure/tmp.vert_profile.png

12 changes: 6 additions & 6 deletions docs/Users_Guide/histogram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ frequency histogram. These plots are customized versions of the histogram plot.

**Rank histogram:**

.. image:: rank_hist.png
.. image:: figure/rank_hist.png


**Probability histogram:**

.. image:: prob_hist.png
.. image:: figure/prob_hist.png

**Relative Frequency histogram:**

.. image:: rel_hist.png
.. image:: figure/rel_hist.png


Example
Expand Down Expand Up @@ -280,7 +280,7 @@ perform the following:
in the directory that was specified in the *plot_filename*
setting of the **minimal_histogram.yaml** config file:

.. image:: rank_hist.png
.. image:: figure/rank_hist.png

**To generate the probability histogram**, re-run the above
command using the **prob_hist.yaml** file:
Expand All @@ -289,7 +289,7 @@ perform the following:
python $METPLOTPY_BASE/metplotpy/plots/histogram/prob_hist.py $WORKING_DIR/prob_hist.yaml
.. image:: prob_hist.png
.. image:: figure/prob_hist.png

**To generate the relative frequency histogram**, re-run the above
command using the **rel_hist.yaml** file:
Expand All @@ -298,7 +298,7 @@ perform the following:
python $METPLOTPY_BASE/metplotpy/plots/histogram/rel_hist.py $WORKING_DIR/rel_hist.yaml
.. image:: rel_hist.png
.. image:: figure/rel_hist.png


* A **rank_hist.png** output file will be created in
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/histogram_2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ The **histogram_2d_defaults.yaml** configuration file, in combination with the
tool grid_diag), generates a 2D-histogram plot of the hist_TMP_Z2_TMP_P500
variable:

.. image:: tmp_z2_p500.png
.. image:: figure/tmp_z2_p500.png

Perform the following:

Expand Down Expand Up @@ -256,7 +256,7 @@ Perform the following:
In this example, this custom config file changes the title and font size.

.. image:: custom_tmp_z2_p500.png
.. image:: figure/custom_tmp_z2_p500.png

* A **custom_tmp_z2_p500.png** output file will be created in the directory
specified in the *plot_filename* configuration setting in the
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/hovmoeller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Run from the Command Line
The Hovmoeller plot that uses only the default values defined in
the **hovmoeller_defaults.yaml** configuration file looks like the following:

.. image:: hovmoeller_default.png
.. image:: figure/hovmoeller_default.png

Perform the following:

Expand Down Expand Up @@ -269,7 +269,7 @@ downloaded/cloned METplotpy code.
shown below. The user can experiment with the values in the custom_hovmoeller.yaml configuration file
to achieve the desired appearance.

.. image:: hovmoeller_custom_plot.png
.. image:: figure/hovmoeller_custom_plot.png

* A **custom_hovmoeller.png** output file will be created in the
directory that was specified in the *plot_filename* configuration
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/line.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ The **custom_line.yaml** configuration file, in combination with the
**line_defaults.yaml** configuration file, generate a plot of
five series:

.. image:: line.png
.. image:: figure/line.png

To generate the above plot using the **line_defaults.yaml** and
**custom_line.yaml** config files, perform the following:
Expand Down Expand Up @@ -248,7 +248,7 @@ To generate the above plot using the **line_defaults.yaml** and
directory specified in the *plot_filename* configuration setting
in the **line_defaults.yaml** config file.

.. image:: line_default.png
.. image:: figure/line_default.png

**NOTE**: This default plot does not display any of the data points.
It is to be used as a template for
Expand Down
6 changes: 3 additions & 3 deletions docs/Users_Guide/performance_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ equal Critical Success Index (CSI) connect the top of the plot to the
right side. CSI amounts are listed to the right side of the plot,
with better values falling closer to the top.

.. image:: performance_diagram_default.png
.. image:: figure/performance_diagram_default.png

Example
=======
Expand Down Expand Up @@ -255,7 +255,7 @@ perform the following:
in the directory that was specified in the *plot_filename*
setting of the **minimal_performance_diagram.yaml** config file:

.. image:: performance_diagram_default.png
.. image:: figure/performance_diagram_default.png

To generate a slightly modified, **customized** plot, re-run the above
command using the **custom_performance_diagram.yaml** file:
Expand All @@ -264,7 +264,7 @@ perform the following:
python $METPLOTPY_BASE/metplotpy/plots/performance_diagram/performance_diagram.py $WORKING_DIR/custom_performance_diagram.yaml
.. image:: performance_diagram_custom.png
.. image:: figure/performance_diagram_custom.png

* A **performance_diagram_custom.png** output file will be created in
the directory that was specified in the *plot_filename* config setting
Expand Down
6 changes: 3 additions & 3 deletions docs/Users_Guide/polar_plot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,6 @@ directory.

Three plots named **20210305_120000_fcst_ice_north.png** **20210305_120000_ice_diff_north.png** **20210305_120000_observation_ice_north.png** will be generated in the sub directory ice_plots from where you ran the above command:

.. image:: fcst_ice_north.png
.. image:: ice_diff_north.png
.. image:: obs_ice_north.png
.. image:: figure/fcst_ice_north.png
.. image:: figure/ice_diff_north.png
.. image:: figure/obs_ice_north.png
4 changes: 2 additions & 2 deletions docs/Users_Guide/reliability_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Run from the Command Line
The reliability diagram plot that uses only the default values defined in
the **reliability_defaults.yaml** configuration file looks like the following:

.. image:: default_reliability_diagram.png
.. image:: figure/default_reliability_diagram.png

To generate the above plot, use the **reliability_defaults.yaml** file,
the "empty" custom configuration file and the
Expand Down Expand Up @@ -261,7 +261,7 @@ Perform the following:
In this example, this custom config file changes the color of the boxes.

.. image:: custom_reliability_diagram.png
.. image:: figure/custom_reliability_diagram.png

* A **custom_reliability_diagram.png** output file will be created in
the directory specified in the *plot_filename* configuration setting
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/roc_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ Run from the Command Line
The ROC diagram plot that uses only the default values defined in
the **roc_diagram_defaults.yaml** configuration file looks like the following:

.. image:: roc_diagram_default.png
.. image:: figure/roc_diagram_default.png

Perform the following:

Expand Down Expand Up @@ -269,7 +269,7 @@ Perform the following:
to achieve the desired appearance.


.. image:: roc_diagram_custom.png
.. image:: figure/roc_diagram_custom.png

* A **custom_roc_diagram.png** output file will be created in the
directory that was specified in the *plot_filename* configuration
Expand Down
8 changes: 4 additions & 4 deletions docs/Users_Guide/stratosphere_diagnostics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ for the meridional mean temperature for the polar cap:

* Contour plot of zonal mean wind:

.. image:: zonal_mean_wind_contour.png
.. image:: figure/zonal_mean_wind_contour.png


* Contour plot of zonal mean temperature:

.. image:: zonal_mean_temperature_contour.png
.. image:: figure/zonal_mean_temperature_contour.png

* Line plot zonal mean wind:

.. image:: zonal_mean_wind.png
.. image:: figure/zonal_mean_wind.png


* Line plot meridional mean temperature at the pole:

.. image:: polar_cap_meridional_mean_temp.png
.. image:: figure/polar_cap_meridional_mean_temp.png


The **directional_means.py** module in the METcalcpy repository
Expand Down
8 changes: 4 additions & 4 deletions docs/Users_Guide/taylor_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Examples of Taylor diagrams are shown below.
A Taylor diagram of sample Downward Longwave Radiative Flux (DLWR) data displaying only positive correlation
values:

.. image:: taylor_pos_corr_plot.png
.. image:: figure/taylor_pos_corr_plot.png

A Taylor diagram of sample Downward Longwave Radiative Flux (DLWR) data displaying negative and
positive correlation values:

.. image:: taylor_neg_and_pos_corr_plot.png
.. image:: figure/taylor_neg_and_pos_corr_plot.png


Example
Expand Down Expand Up @@ -231,7 +231,7 @@ perform the following:
in the directory that was specified in the *plot_filename*
setting of the **minimal_taylor_diagram.yaml** config file:

.. image:: taylor_diagram_default.png
.. image:: figure/taylor_diagram_default.png

To generate a slightly modified, **customized** plot, run the
command (below) using the **taylor_diagram_custom.yaml** file:
Expand All @@ -248,4 +248,4 @@ perform the following:
output filename, title text, title size, title font style, caption text, and different symbols than the default
plot, as shown below:

.. image:: taylor_diagram_custom.png
.. image:: figure/taylor_diagram_custom.png
Loading

0 comments on commit fcd8ed7

Please sign in to comment.