Skip to content

Commit

Permalink
update docstrings in UFS_plot_domains
Browse files Browse the repository at this point in the history
  • Loading branch information
gspetro-NOAA committed Sep 17, 2024
1 parent 981e83b commit 9ad2328
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions ush/UFS_plot_domains.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
import matplotlib.patches as patches
import numpy as np

"""This script generates a plot of the ESG grid and the write component grid.
To use this script, modify the ESG grid and write component grid parameters in this script
manually to reflect the configuration of the grids you wish to plot. Then run the script. """

#### User-defined variables

if __name__ == "__main__":
Expand Down Expand Up @@ -137,10 +141,10 @@ def get_lambert_points(gnomonic_map, lambert_map, pps):
Start array with bottom left point, "MOVETO" instruction
Args:
gnomonic_map:
lambert_map:
gnomonic_map (Basemap): A map of the ESG grid
lambert_map (Basemap): A map of the write component grid
pps: The number of points to interpolate and draw for each side of the lambert
"rectangle". It is recommended to set to 10 or less due to time of calculation.
"rectangle." It is recommended to set to 10 or less due to time of calculation.
Returns:
vertices, instructions: A tuple of two lists---a list of tuples of the ``4*ppf + 4``
Expand Down

0 comments on commit 9ad2328

Please sign in to comment.