Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix mistakes in example section for P2G Version 3.1 release #704

Merged
merged 2 commits into from
Aug 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/source/examples/acspo_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Find the options available for creating ACSPO VIIRS SST GeoTIFFs:

List the products that can be created from your ACSPO NetCDF dataset:

``polar2grid.sh -r acspo -w geotiff --list-products -f <path_to_l1b_file>``
``polar2grid.sh -r acspo -w geotiff --list-products -f <path_to_acspo_file>``

To create the default product image, which is `sst` taken from
the `sea_surface_temperature` array in the ACSPO file,
Expand Down Expand Up @@ -137,7 +137,7 @@ To add a color enhancement to this image, I use the *add_colormap.sh* utility
script and a rainbow color table `p2g_sst_palette.txt` that is included as part of
the Polar2Grid package. This table is formatted as described in the
:ref:`util_add_colormap` section. You can view the file
`online <https://github.com/ssec/polar2grid/blob/main/etc/colormaps/p2g_sst_palette.txt>`_.
`online <https://github.com/ssec/polar2grid/blob/main/polar2grid/etc/colormaps/p2g_sst_palette.txt>`_.

This colormap will assign a color value to each of the 0-255 brightness range
in the GeoTIFF image. Again, the default brightness range is associated with a
Expand Down Expand Up @@ -165,7 +165,7 @@ full range of brightness values. In order to do this, I need to create a new
rescaling `yaml` file that I will then provide to polar2grid.sh.

I chose an enhancment name of `great_lakes_sst` and will use the same standard_name of
`sea_surface_subskin_temperature` and then redefined the relationship between the brightness
`sea_surface_subskin_temperature` and then redefine the relationship between the brightness
values and the data. I tighten the temperature range to be between 275.0 K and 305.0 K. The contents of
my new rescale yaml file is shown below (`my_rescale.yaml`).

Expand Down
4 changes: 2 additions & 2 deletions doc/source/examples/asci_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ data files, I would use this command:

.. code-block:: bash
polar2grid.sh -r acspo -w geotiff -p AOD550 -f viirs/JRR-AOD_*j01_s20240605185*.nc
polar2grid.sh -r viirs_edr -w geotiff -p AOD550 -f viirs/JRR-AOD_*j01_s20240605185*.nc
An aggregated GeoTIFF image will be created from the 7 granule input files with the data
re-projected into the WGS84 (Platte Carrée) projection by default. The image scaling
Expand Down Expand Up @@ -173,7 +173,7 @@ is shown below, followed by the output image.
--colorbar-title="Normalized Difference Vegetation Index (NDVI)" --add-coastlines \
--coastlines-outline "black" --coastlines-level 1 \
--coastlines-resolution=i --add-borders --borders-level 2 \
--borders-outline gray --coastlines-width 2 --colorbar-tick-marks 10 \
--borders-outline gray --coastlines-width 2 --colorbar-tick-marks 0.1 \
--colorbar-height 150 --colorbar-text-size 100
.. raw:: latex
Expand Down
10 changes: 4 additions & 6 deletions doc/source/readers/viirs_edr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,10 @@ Examples:
polar2grid.sh -r viirs_edr -w geotiff -h
polar2grid.sh -r viirs_edr -w geotiff --list-products -f ../edr/*.h5
polar2grid.sh -r viirs_edr -w geotiff --list-products -f ../edr/*.nc
polar2grid.sh -r viirs_edr -w geotiff -p true_color_surf false_color_surf --num-workers 8 --no-tiled -f ../edr/*.h5
polar2grid.sh -r viirs_edr -w geotiff -p true_color_surf false_color_surf --num-workers 8 -f ../edr/edr/SurfRefl*.nc
polar2grid.sh -r viirs_edr -w hdf5 --add-geolocation --dtype float32 -p NDVI EVI --maximum-weight-mode -f SurfRefl*.nc
Product Explanation
-------------------

TODO
polar2grid.sh -r viirs_edr -w awips_tiled -p AOD550 CldTopHght CldTopTemp -g lcc_conus_300 --sector-id LCC --letters --compress -f /viirs/JRR-AOD_v3r0_j01_s202406051854471_e202406051856116_c202406052204237.nc /viirs/JRR-CloudHeight_v3r0_j01_s202406051854471_e202406051856116_c202406052204237.nc