Skip to content

Commit

Permalink
documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardhartnett committed Nov 14, 2023
1 parent b943de9 commit 579e6aa
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/Intel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
rm GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list
sudo apt-get update
sudo apt-get install intel-oneapi-dev-utilities intel-oneapi-mpi-devel intel-oneapi-openmp intel-oneapi-compiler-fortran intel-oneapi-compiler-dpcpp-cpp-and-cpp-classic
sudo apt-get install intel-oneapi-dev-utilities intel-oneapi-mpi-devel intel-oneapi-compiler-fortran-2023.2.1 intel-oneapi-compiler-dpcpp-cpp-and-cpp-classic-2023.2.1 intel-oneapi-openmp
echo "source /opt/intel/oneapi/setvars.sh" >> ~/.bash_profile
- name: checkout-bacio
Expand Down
21 changes: 13 additions & 8 deletions src/compack.f
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
!> @file
!> @brief This subroutine packs up a GRIB2 data field.
!> @brief Pack a data field with complex packing with
!> or without spatial differences defined in [Data Representation
!> Template5.2 - Grid point data - complex
!> packing](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-2.shtml)
!> and [Data Representation Template 5.3 - Grid point data - complex
!> packing and spatial
!> differencing](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-3.shtml).
!> @author Stephen Gilbert @date 2000-06-21

!> This subroutine supports GRIB2 complex packing templates with or
!> without spatial differences, Data Representation Templates (DRT)
!> [GRIB2 - DATA REPRESENTATION TEMPLATE 5.2 - Grid point data -
!> complex
!> Pack a data field with complex packing with or
!> without spatial differences, defined in [Data Representation
!> Template5.2 - Grid point data - complex
!> packing](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-2.shtml)
!> and [GRIB2 - DATA REPRESENTATION TEMPLATE 5.3 - Grid point data -
!> complex packing and spatial
!> and [Data Representation Template 5.3 - Grid point data - complex
!> packing and spatial
!> differencing](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-3.shtml).
!>
!> It also fills in GRIB2 Data Representation Template 5.2 or 5.3 with
!> It also fills in Data Representation Template 5.2 or 5.3 with
!> the appropriate values.
!>
!> @param[in] fld The data values to pack.
Expand Down
11 changes: 7 additions & 4 deletions src/jpcpack.F90
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
!> @file
!> @brief Pack a data field into a JPEG2000 code stream.
!> @brief Pack a data field into a JPEG2000 code stream as defined in
!> [Data Representation Template
!> 5.40](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-40.shtml).
!> @author Stephen Gilbert @date 2002-12-17

!> Pack a data field into a JPEG2000 code stream.
!> Pack a data field into a JPEG2000 code stream as defined in
!> [Data Representation Template
!> 5.40](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-40.shtml).
!>
!> After the data field is scaled, and the reference value is
!> subtracted out, it is treated as a grayscale image and passed to a
!> JPEG2000 encoder. It also fills in [GRIB2 - TABLE 5.40 TYPE OF
!> COMPRESSION](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_table5-40.shtml).
!> JPEG2000 encoder. This subroutine also fills in the DRT values.
!>
!> @param[in] fld The data values to pack.
!> @param[in] width number of points in the x direction
Expand Down
8 changes: 6 additions & 2 deletions src/jpcunpack.F90
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
!> @file
!> @brief Unpack a data field from a JPEG2000 code stream.
!> @brief Unpack a data field from a JPEG2000 code stream as defined in
!> [Data Representation Template
!> 5.40](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-40.shtml).
!> @author Stephen Gilbert @date 2002-12-17

!> Unpack a data field from a JPEG2000 code stream.
!> Unpack a data field from a JPEG2000 code stream as defined in
!> [Data Representation Template
!> 5.40](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-40.shtml).
!>
!> This subroutine unpacks a data field that was packed into a
!> JPEG2000 code stream using info from the GRIB2 Data Representation
Expand Down

0 comments on commit 579e6aa

Please sign in to comment.