Skip to content

Commit

Permalink
Merge branch 'main' into inf_doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hkershaw-brown authored Jul 11, 2024
2 parents e3a4f82 + b825400 commit 1ef4f20
Show file tree
Hide file tree
Showing 9 changed files with 194 additions and 102 deletions.
81 changes: 81 additions & 0 deletions .github/workflows/run_all_quickbuilds.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: 'run all quickbuilds'
on:
workflow_dispatch:

jobs:
setup:
runs-on: ubuntu-latest
container:
image: hkershaw/dart-dep-external:2.0
options: "--cap-add=SYS_PTRACE"
outputs:
matrix: ${{ steps.matrix.outputs.value }}
steps:
- uses: actions/checkout@v4
- id: matrix
run: |
git config --global --add safe.directory /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
DART=$(git rev-parse --show-toplevel)
files_to_process=( $(find $DART -executable -type f -name quickbuild.sh | sed -E 's#(\./|quickbuild\.sh)##g') )
joined_items=""
for item in "${files_to_process[@]}"; do
if [[ $item == *"template"* ]]; then
continue # template model not for compiling
fi
if [[ $item == *"/var/"* ]] || [[ $item == *"/gps/"* ]]; then
# skipping these converters, out of the box quickbuild.sh fails
# var needs wrf files
# gps need prepbuffr bufrlib.a to be built
continue
fi
# Append the quoted item and a comma to the string
stripped_item=${item#/__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}/} # removes /__w/DART/DART
echo $stripped_item
joined_items+="\"$stripped_item\","
done
# Remove the trailing comma from the last item
joined_items="${joined_items%,}"
echo "value=[ $joined_items ]" >> $GITHUB_OUTPUT
shell: bash
build:
needs: [ setup ]
runs-on: ubuntu-latest
container:
image: hkershaw/dart-dep-external:2.0
options: "--cap-add=SYS_PTRACE"
strategy:
fail-fast: false
matrix:
value: ${{fromJSON(needs.setup.outputs.matrix)}}
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Set checked out repo as a safe git directory
run: git config --global --add safe.directory /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
- name: Creating Makefile template
run: |
cd build_templates
sed -i 's|exec '\''make'\'', '\''-f'\'', \$opt_m if \$opt_x;|exec '\''make'\'', '\''-j'\'', '\''4'\'', '\''-f'\'', \$opt_m if \$opt_x;|' mkmf
case ${{ matrix.value }} in
*quikscat* | *GSI2DART* )
cp /home/mkmf.template.quikscat.gfortran mkmf.template
;;
*AIRS*)
cp /home/mkmf.template.AIRS.gfortran mkmf.template
;;
*GMI* | *GOES* | *forward_operators* | *NSIDC* )
cp /home/mkmf.template.rttov.gfortran mkmf.template
;;
*)
cp mkmf.template.gfortran mkmf.template
echo 'FFLAGS = -g -Wuninitialized -Wunused -ffree-line-length-none -fbounds-check -fbacktrace -ffpe-trap=invalid,zero,overflow $(INCS)' >> mkmf.template
;;
esac
shell: bash
- name: Run quickbuild.sh script
run: |
cd ${{ matrix.value }}
./quickbuild.sh
shell: bash
7 changes: 7 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ individual files.

The changes are now listed with the most recent at the top.

**July 11 2024 :: Bgrid documentation and scripting fix. Tag v11.5.1**

- Updated Bgrid documentation and removed outdated scripts and files
- Fixed obs_diag rank histogram documentation links
- Improved inflation file documentation
- GitHub action for running all quickbuilds in DART

**May 16 2024 :: WRF v4. Tag v11.5.0**

- WRF-DART and WRF-DART Tutorial updated to WRFv4. Note, not backwards compatible with WRFv3.9.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ the quantity (for every variable, every level, every region) in a single matlab
figure window - and creates a series of .ps files with multiple pages for each
of the figures. The directory gets cluttered with them. The rank histogram
information in ``obs_diag_output.nc`` can easily be plotted with
`ncview <http://meteora.ucsd.edu/~pierce/ncview_home_page.html>`__ (left),
`ncview`_. (left),
a free third-party piece of software or with ``plot_rank_histogram.m`` (right).
See the `Rank histograms`_ section for more information and links to instructions.

Expand Down Expand Up @@ -552,10 +552,9 @@ Please note:

+-----------+----------------------------------------------------------------------------------------------------------+
| |image3| | `Instructions for viewing the rank histogram with |
| | ncview <http://www.image.ucar.edu/DAReS/DART/DART2_Documentation.php#ncview_histogram>`__. |
| | ncview <https://cirrus.ucsd.edu/ncview/>`__. |
+-----------+----------------------------------------------------------------------------------------------------------+
| |image4| | `Instructions for viewing the rank histogram with |
| | Matlab <http://www.image.ucar.edu/DAReS/DART/DART2_Documentation.php#mat_obs>`__. |
| |image4| | :ref:`Instructions for viewing the rank histogram with Matlab<plotRankHistogram>`. |
+-----------+----------------------------------------------------------------------------------------------------------+

"trusted" observation types
Expand Down Expand Up @@ -746,7 +745,7 @@ portion of the run-time output:
variable in the netCDF file.
| Now that you have the ``obs_diag_output.nc``, you can explore it with ``plot_profile.m, plot_bias_xxx_profile.m, or
plot_rmse_xxx_profile.m``,
rank histograms with `ncview <http://meteora.ucsd.edu/~pierce/ncview_home_page.html>`__ or ``plot_rank_histogram.m``.
rank histograms with `ncview`_ or ``plot_rank_histogram.m``.
References
----------
Expand All @@ -768,3 +767,6 @@ N/A
:width: 600px
.. |image5| image:: ../../../../guide/images/RAD_T_trusted_bias_evolution.png
:width: 600px

.. _ncview: https://cirrus.ucsd.edu/ncview/

14 changes: 9 additions & 5 deletions assimilation_code/programs/obs_diag/threed_sphere/obs_diag.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _obs-diag-threed-sphere:

PROGRAM ``obs_diag`` (for observations that use the threed_sphere location module)
==================================================================================

Expand Down Expand Up @@ -77,7 +79,7 @@ the quantity (for every variable, every level, every region) in a single matlab
figure window - and creates a series of .ps files with multiple pages for each
of the figures. The directory gets cluttered with them. The rank histogram
information in ``obs_diag_output.nc`` can easily be plotted with
`ncview <http://meteora.ucsd.edu/~pierce/ncview_home_page.html>`__ (left),
`ncview`_. (left),
a free third-party piece of software or with ``plot_rank_histogram.m`` (right).
See the `Rank histograms`_ section for more information and links to instructions.

Expand Down Expand Up @@ -536,10 +538,9 @@ Please note:

+-----------+----------------------------------------------------------------------------------------------------------+
| |image3| | `Instructions for viewing the rank histogram with |
| | ncview <http://www.image.ucar.edu/DAReS/DART/DART2_Documentation.php#ncview_histogram>`__. |
| | ncview <https://cirrus.ucsd.edu/ncview/>`__. |
+-----------+----------------------------------------------------------------------------------------------------------+
| |image4| | `Instructions for viewing the rank histogram with |
| | Matlab <http://www.image.ucar.edu/DAReS/DART/DART2_Documentation.php#mat_obs>`__. |
| |image4| | :ref:`Instructions for viewing the rank histogram with Matlab<plotRankHistogram>`. |
+-----------+----------------------------------------------------------------------------------------------------------+

"trusted" observation types
Expand Down Expand Up @@ -730,7 +731,7 @@ portion of the run-time output:
variable in the netCDF file.
| Now that you have the ``obs_diag_output.nc``, you can explore it with ``plot_profile.m, plot_bias_xxx_profile.m, or
plot_rmse_xxx_profile.m``,
rank histograms with `ncview <http://meteora.ucsd.edu/~pierce/ncview_home_page.html>`__ or ``plot_rank_histogram.m``.
rank histograms with `ncview`_ or ``plot_rank_histogram.m``.
References
----------
Expand All @@ -752,3 +753,6 @@ N/A
:width: 600px
.. |image5| image:: ../../../../guide/images/RAD_T_trusted_bias_evolution.png
:width: 600px

.. _ncview: https://cirrus.ucsd.edu/ncview/

2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
author = 'Data Assimilation Research Section'

# The full version, including alpha/beta/rc tags
release = '11.5.0'
release = '11.5.1'
root_doc = 'index'

# -- General configuration ---------------------------------------------------
Expand Down
5 changes: 4 additions & 1 deletion guide/matlab-observation-space.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,10 @@ multiple axes on a single figure.
|two experiments profile example|

----------------------------------------
.. _plotRankHistogram:

plot_rank_histogram
-------------------

`plot_rank_histogram.m <https://raw.githubusercontent.com/NCAR/DART/master/diagnostics/matlab/plot_rank_histogram.m>`__ will
create rank histograms for any variable that has that information present in
Expand Down
Loading

0 comments on commit 1ef4f20

Please sign in to comment.