From 118c29332d91f5fba757e1b7f63377ed15ef4678 Mon Sep 17 00:00:00 2001 From: Ed Date: Tue, 8 Oct 2024 10:05:33 -0600 Subject: [PATCH 1/4] more docs --- ush/UFS_plot_domains.py | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/ush/UFS_plot_domains.py b/ush/UFS_plot_domains.py index a6e629bd1..b7f14b9b5 100755 --- a/ush/UFS_plot_domains.py +++ b/ush/UFS_plot_domains.py @@ -1,5 +1,7 @@ #!/usr/bin/env python - +""" +Plot domains? +""" import matplotlib.pyplot as plt from mpl_toolkits.basemap import Basemap from matplotlib.path import Path @@ -108,15 +110,16 @@ # Define a function to get the lambert points in the gnomonic space def get_lambert_points(gnomonic_map, lambert_map,pps): - print("Hello from a function") + """ + This function takes the lambert domain we have defined, lambert_map, as well as + pps (the number of points to interpolate and draw for each side of the lambert "rectangle"), + and returns an array of two lists: one a list of tuples of the 4*ppf + 4 vertices mapping the approximate shape + of the lambert domain on the gnomonic map, the other a list of "draw" instructions to be used by + the PathPatch function. - # This function takes the lambert domain we have defined, lambert_map, as well as - # pps (the number of points to interpolate and draw for each side of the lambert "rectangle"), - # and returns an array of two lists: one a list of tuples of the 4*ppf + 4 vertices mapping the approximate shape - # of the lambert domain on the gnomonic map, the other a list of "draw" instructions to be used by - # the PathPatch function - - # pps is recommended 10 or less due to time of calculation + pps is recommended 10 or less due to time of calculation. + """ + print("Hello from a function") # Start array with bottom left point, "MOVETO" instruction vertices = [gnomonic_map(*lambert_map(lambert_map.xmin, lambert_map.ymin, inverse= True))] From 3e481e4c503f8ecc3732bda5c376fb5abaf2b68e Mon Sep 17 00:00:00 2001 From: Ed Date: Tue, 8 Oct 2024 10:10:08 -0600 Subject: [PATCH 2/4] more docs --- docs/requirements.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 7be32f526..4a4d3d18e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,5 @@ sphinxcontrib-bibtex sphinx_rtd_theme -docutils==0.16 \ No newline at end of file +docutils==0.16 +numpy +matplotlib From 76f87f4a2033555cc3dea9856c22672ecaa8e2d0 Mon Sep 17 00:00:00 2001 From: Ed Date: Wed, 9 Oct 2024 07:11:18 -0600 Subject: [PATCH 3/4] more docs --- ush/UFS_plot_domains.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/ush/UFS_plot_domains.py b/ush/UFS_plot_domains.py index b7f14b9b5..2af12c210 100755 --- a/ush/UFS_plot_domains.py +++ b/ush/UFS_plot_domains.py @@ -118,6 +118,10 @@ def get_lambert_points(gnomonic_map, lambert_map,pps): the PathPatch function. pps is recommended 10 or less due to time of calculation. + + gnomonic_map: ??? + lambert_map: ??? + pps: ??? """ print("Hello from a function") From 26179c40cb623b820cbc634978d51e3f79ac8903 Mon Sep 17 00:00:00 2001 From: Ed Date: Wed, 9 Oct 2024 07:12:29 -0600 Subject: [PATCH 4/4] more docs --- ush/UFS_plot_domains.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ush/UFS_plot_domains.py b/ush/UFS_plot_domains.py index 2af12c210..b41621453 100755 --- a/ush/UFS_plot_domains.py +++ b/ush/UFS_plot_domains.py @@ -120,8 +120,8 @@ def get_lambert_points(gnomonic_map, lambert_map,pps): pps is recommended 10 or less due to time of calculation. gnomonic_map: ??? - lambert_map: ??? - pps: ??? + lambert_map: the lambert domain we have defined + pps: the number of points to interpolate and draw for each side of the lambert "rectangle" """ print("Hello from a function")