merged and resolved

MitchellBlack · MitchellBlack · commit fcf70181451f · 2025-05-15T10:36:41.000+10:00
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ Funded by ACS.
 
 If you use this software please cite it as :
 
-Tolhurst, G., & Black, M. (2025) plotting_maps. GitHub. Accessed [Date], from https://github.com/AusClimateService/plotting_maps
+Tolhurst, G., & Black, M. (2025). plotting_maps (Version 1.0.0) [Computer software]. https://doi.org/10.5281/zenodo.1234
 
 ## What's possible?
 
@@ -34,11 +34,11 @@ There are many possibilities built into this function. ```plot_acs_hazard``` is
 
 To access docstrings and learn about input arguments, use ```plot_acs_hazard?```. This will describe each parameter you can give to the function to customise your plot.
 
- - Basic usage: Single plot of Australia eg temperature  [Climate_and_hazards_report](https://github.com/AusClimateService/plotting_maps/blob/main/reports/Climate_and_hazards_report.ipynb) and [acs_plotting_maps_examples.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/acs_plotting_maps_examples.ipynb)
-<img src="https://github.com/AusClimateService/plotting_maps/blob/main/figures/ch_report/Annual-maximum-daily%0Amaximum-temperature.png" width="300">
+ - Basic usage: Single plot of Australia eg temperature [minimal_plotting_example_tx.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/minimal_plotting_example_tx.ipynb),  [story_map_plots.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/reports/story_map_plots.ipynb) and [acs_plotting_maps_examples.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/acs_plotting_maps_examples.ipynb)
+<img src="https://github.com/AusClimateService/plotting_maps/blob/main/figures/Maximum-Temperature-of-Hottest-Heatwave.png" width="300">
 
- - Plot ocean data: Plots of ocean data eg marine heat waves [acs_plotting_maps_examples.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/acs_plotting_maps_examples.ipynb), and  [Climate_and_hazards_report](https://github.com/AusClimateService/plotting_maps/blob/main/reports/Climate_and_hazards_report.ipynb)
-<img src="https://github.com/AusClimateService/plotting_maps/blob/main/figures/Ocean-acidification.png" width="300">
+ - Plot ocean data: Plots of ocean data eg marine heat waves [story_map_plots.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/reports/story_map_plots.ipynb), [acs_plotting_maps_examples.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/acs_plotting_maps_examples.ipynb), and  [Climate_and_hazards_report](https://github.com/AusClimateService/plotting_maps/blob/main/reports/Climate_and_hazards_report.ipynb)
+<img src="https://github.com/AusClimateService/plotting_maps/blob/main/figures/story_map_plots/story_map_plots_MHWduration_gwl12.png" width="300">
 
  - Plot data from anywhere in the world eg Antarctica or Europe [FAQ_example_antarctica.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/FAQ_example_antarctica.ipynb)
 
@@ -48,12 +48,12 @@ To access docstrings and learn about input arguments, use ```plot_acs_hazard?```
 
 - Plot atmospheric data above ocean and land, for example, Tropical Cyclones [FAQ_example_TCs.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/FAQ_example_TCs.ipynb)
 
-<img src="https://github.com/user-attachments/assets/b5f21e58-831e-4016-8992-e612060c04da" width="600">
+<img src="https://github.com/AusClimateService/plotting_maps/blob/main/figures/Frequency-of-tropical-cyclones.png" width="600">
 
 
  - Plot stations data: Single plot of station data eg coastal flooding [acs_plotting_maps_examples.ipynb](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/acs_plotting_maps_examples.ipynb), [multi_plots](https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/multi_plots.ipynb) and [Climate_and_hazards_report](https://github.com/AusClimateService/plotting_maps/blob/main/reports/Climate_and_hazards_report.ipynb)
 
-<img src="https://github.com/AusClimateService/plotting_maps/blob/main/figures/ch_report/Change-in-frequency-of-flood-days.png" width="300">
+<img src="https://github.com/AusClimateService/plotting_maps/blob/main/figures/ch_report/Change-in-frequency-of-coastal-flood-days.png" width="300">
   
  - Plot multiple data types in one figure. Gridded data and station data can be plotted on the same plot: eg ocean data and station data (station and gridded data on the same plot) [minimal_plotting_example_station.ipynb]((https://github.com/AusClimateService/plotting_maps/blob/main/example_notebooks/minimal_plotting_example_station.ipynb)
 
@@ -564,8 +564,10 @@ plot_acs_hazard_1plus3(ds_gwl12=ds_gwl12[var],
 ### How can I change the orientation (eg from vertical to horizontal) of the figures in a multipaneled plot?
 <details>
  <summary> Expand </summary>
+
+Use `ncols` and `nrows` in  the `plot_acs_hazard_multi` function to control a multipanelled figure's number of rows and columns.
  
-For multi-panelled plots, we have provided a keyword `orientation` to easily change `"vertical"` stacked plots to `"horizontal"` aligned subplots. For four panelled plots there is also a `"square"` option for a 2-by-2 arrangement. 
+For 2, 3, and 4 multi-panelled plots , we have provided a keyword `orientation` to easily change `"vertical"` stacked plots to `"horizontal"` aligned subplots. For four panelled plots there is also a `"square"` option for a 2-by-2 arrangement. 
 
 These options specify the axes grid, figsize, and location of titles etc.
 
@@ -876,7 +878,7 @@ See for current issues: https://github.com/AusClimateService/plotting_maps/issue
 -	Lightning plot. For the Climate Hazards report, recreate the lightning observations plot using the plot_acs_hazards function so that it is in the consistent format.
 
 **Documentation:**
--	“release” this version of the code as v1.0.0. It is in wide use and care is being taken to keep backward compatibility while adding features. Eg see https://github.com/AusClimateService/plotting_maps/releases/new
+-	Examples and FAQ for using plot_acs_hazard_multi
 
 **Improve plotting function and axillaries:**
 -	If hazard data had consistent file naming practices (DRS) and consistent attribute labels, then the plotting functions could be further automated. At the moment, the data files are named in different patterns, the files might have different names for coordinates (eg “time”, “lat”, “lon”)
@@ -885,14 +887,11 @@ See for current issues: https://github.com/AusClimateService/plotting_maps/issue
 -	Possibly automate the arrows of the colourbar. (I don’t think the arrows on the colorbar should be determined by the data in the plot, I think they should be only limited by possible physical values of that metric so that all colourbars of that metric are comparable. Determine if you want the arrows to be determined by the plotting data or the metric’s possible physical values.)
 -	Use a keyword to make plots appropriate for different uses eg journal, report, powerpoint, poster etc similar to https://seaborn.pydata.org/generated/seaborn.set_context.html
 -	Simplify stored shapefiles or masks. Current masks are 1mm precision, this means that calculations with these regions are more intense than necessary. Most climate data is in the order of ~10 km (rarely ~100 m). Simplifying the geometries of the shapefiles can save lots of resources for no loss in results.
--	Improve the aesthetics and proportions of plotting, especially with dataset/date_range/baseline annotations. Design aesthetics were focused on vertical orientations for 4-panel plots without these annotations for a particular report.
+-	Improve the aesthetics and proportions of plotting, especially with dataset/date_range/baseline annotations for plot_acs_hazard_1plus3, as has been done for plot_acs_hazard_multi. Design aesthetics were focused on vertical orientations for 4-panel plots without these annotations for a particular report.
 -	Improve the aesthetics of plotting select_area. Eg remove boundaries of neighbouring regions (if desired)
--	Forest mask for forested areas. For example, FFDI is not useful in places where there is not connected vegetation/fuel. This is probably particularly for arid desert areas of central Australia. Changes in climate and land use may cause changes over time.
+-	Forest mask for forested areas. For example, FFDI is not useful in places where there is not connected vegetation/fuel. This is probably particularly for arid desert areas of central Australia. Changes in climate and land use may cause changes over time. (see https://github.com/AusClimateService/plotting_maps/blob/main/reports/holistic-australian-bushfire-risk-assessment.ipynb for a possible solution)
 -	Improve colormap for fire climate classes. This colour scheme is not completely colourblind-friendly. Perhaps modify the colours to increase the contrast. 
 
-**New plotting function:**
--	Fully flexible custom n x m grid of plots. At the moment, minor modifications within multiplot are needed to make a custom plot for new layouts. It may be possible to make a function that can take in dimensions and a list of dataarrays to make a figure of many plots. This should use a similar format to the existing multi-panel plots and allow plotting gridded data, station data, stippling, ocean data, etc. (in progress issue #29)
-
 **Stats functions:**
 -	Optimise workflow to enable area-averaged time series (stats or just area mean). This function can be very memory intensive. Need to apply a strategy or strategies to reduce memory use. A possible option may be to calculate and save area averages for every year. Saving outputs in annual files is a common practice for climate models. 
 -	Calculate statistics along streamlines. Similar to area averages, but for a custom transect. Eg for rivers instead of catchments. Eg issue https://github.com/AusClimateService/plotting_maps/issues/23
diff --git a/acs_plotting_maps.py b/acs_plotting_maps.py
@@ -983,7 +983,7 @@ def plot_titles(title="title",
                 ax=None,
                 text_xy = None,
                 title_ha = "left",
-               orientation = "none",):
+                show_copyright = True,):
     """
     Set the plot title and axis labels
     
@@ -1037,11 +1037,10 @@ def plot_titles(title="title",
     title_ha: {"left", "center", "right"}
         Title horizontal alignment.
         Default "left"
-    
-    orientation: {"vertical", "horizontal"}
-        Orientation of figures, used to control layout of Copywrite text.
-        I.e. vertically stacked, or horizontal side-by-side
-        
+
+    show_copyright: bool
+        Default True
+
     Returns
     -------
     matplotlib.axes.Axes with text for titles etc.
@@ -1088,22 +1087,23 @@ def plot_titles(title="title",
             transform=ax.transAxes,
             zorder=10,
         )
-    # print copyright outside bottom left corner
-    if figsize[0]<5.3:
-        string =""# f"\u00A9 Commonwealth of Australia {datetime.datetime.now().year}, \nAustralian Climate Service"
-    else:
-        string = ""#f"\u00A9 Commonwealth of Australia {datetime.datetime.now().year}, Australian Climate Service"
-    ax.text(
-        x=padding*xpt,
-        y=(padding+2*fontsize_footnote)*ypt,
-        s=string,
-        fontsize=fontsize_footnote,
-        transform=ax.transAxes,
-        verticalalignment="top",
-        zorder=10,
-        wrap=True,
-    )
-    if dataset_name is not None:
+   if show_copyright:
+        # print copyright outside bottom left corner
+        if figsize[0]<5.3:
+            string = f"\u00A9 Commonwealth of Australia {datetime.datetime.now().year}, \nAustralian Climate Service"
+        else:
+            string = f"\u00A9 Commonwealth of Australia {datetime.datetime.now().year}, Australian Climate Service"
+        ax.text(
+            x=padding*xpt,
+            y=(padding+2*fontsize_footnote)*ypt,
+            s=string,
+            fontsize=fontsize_footnote,
+            transform=ax.transAxes,
+            verticalalignment="top",
+            zorder=10,
+            wrap=True,
+        )
+   if dataset_name is not None:
         # print data source inside bottom right
         ax.text(
             x=1- padding*xpt,
@@ -1211,6 +1211,7 @@ def plot_acs_hazard_multi(
                 savefig=True,
                 tick_rotation=None,
                 vcentre=None,
+                show_copyright=True,
             ):
     """
     m-by-n panel plot with shared projection and titles etc. 
@@ -1446,6 +1447,9 @@ def plot_acs_hazard_multi(
         around the centre, eg for future temperature anomalies with a larger
         positive range compared to the negative range.
 
+    show_copyright: bool
+        Default True
+        
     Returns
     -------
     A multi panel plot saved as a png in a "figures" file in your working directory.
@@ -1703,6 +1707,7 @@ def plot_acs_hazard_multi(
                         ax=ax111,
                         text_xy = text_xy,
                         title_ha = "center",
+                        show_copyright=show_copyright,
                    )
     # draw border
     # ax111.axis(True)
@@ -1762,6 +1767,7 @@ def plot_acs_hazard(
     savefig=True,
     tick_rotation=None,
     vcentre=None,
+    show_copyright=True,
 ):
     """This function takes gridded data or station_df dataframe and shapefiles 
     to visualise hazard data from a 2D Xarray data array
@@ -1955,6 +1961,9 @@ def plot_acs_hazard(
         around the centre, eg for future temperature anomalies with a larger
         positive range compared to the negative range.
 
+    show_copyright: bool
+        Default True
+
     Returns
     -------
     The map is saved as a png in a "figures" file in your working directory.
@@ -2085,6 +2094,7 @@ def plot_acs_hazard(
                         ax=ax111,
                         text_xy = text_xy_1pp,
                         title_ha = "left",
+                        show_copyright=show_copyright,
                         )
     # -----------------------------------------------
 
@@ -2144,6 +2154,7 @@ def plot_acs_hazard_1pp(
     savefig=True,
     tick_rotation=None,
     vcentre=None,
+    show_copyright=True,
 ):
     """This function takes gridded data or station_df dataframe and shapefiles 
     to visualise hazard data from a 2D Xarray data array
@@ -2341,6 +2352,9 @@ def plot_acs_hazard_1pp(
         around the centre, eg for future temperature anomalies with a larger
         positive range compared to the negative range.
 
+    show_copyright: bool
+        Default True
+
     Returns
     -------
     The map is saved as a png in a "figures" file in your working directory.
@@ -2405,7 +2419,9 @@ def plot_acs_hazard_1pp(
                                 outfile=outfile,
                                 savefig=savefig,
                                 tick_rotation=tick_rotation,
-                                vcentre=vcentre,)
+                                vcentre=vcentre,
+                                show_copyright=show_copyright,
+                                )
     
 
 def plot_acs_hazard_2pp(
@@ -2456,6 +2472,7 @@ def plot_acs_hazard_2pp(
     orientation="horizontal",
     tick_rotation=None,
     vcentre=None,
+    show_copyright=True,
 ):
     """
     Two panel plot with shared cmap and titles etc. 
@@ -2694,6 +2711,9 @@ def plot_acs_hazard_2pp(
         around the centre, eg for future temperature anomalies with a larger
         positive range compared to the negative range.
 
+    show_copyright: bool
+        Default True
+
     Returns
     -------
     A two panel plot saved as a png in a "figures" file in your working directory.
@@ -2772,7 +2792,9 @@ def plot_acs_hazard_2pp(
                                 outfile=outfile,
                                 savefig=savefig,
                                 tick_rotation=tick_rotation,
-                                vcentre=vcentre,)
+                                vcentre=vcentre,
+                                show_copyright=show_copyright,
+                                )
     
 
 
@@ -2829,7 +2851,8 @@ def plot_acs_hazard_3pp(
     orientation="horizontal",
     tick_rotation=None,
     vcentre=None,
-):
+    show_copyright=True,
+    ):
     """
     Three panel plot with shared cmap and titles etc. 
     As with plot_acs_hazard, but takes three xarray data arrays:
@@ -3082,6 +3105,9 @@ def plot_acs_hazard_3pp(
         around the centre, eg for future temperature anomalies with a larger
         positive range compared to the negative range.
 
+    show_copyright: bool
+        Default True
+
     Returns
     -------
     A three panel plot saved as a png in a "figures" file in your working directory.
@@ -3158,7 +3184,9 @@ def plot_acs_hazard_3pp(
                                 outfile=outfile,
                                 savefig=savefig,
                                 tick_rotation=tick_rotation,
-                                vcentre=vcentre,)
+                                vcentre=vcentre,
+                                show_copyright=show_copyright,
+                                )
 
 
 def plot_acs_hazard_4pp(
@@ -3218,6 +3246,7 @@ def plot_acs_hazard_4pp(
                 orientation="vertical",
                 tick_rotation=None,
                 vcentre=None,
+                show_copyright=True,
             ):
     """
     Four panel plot with shared cmap and titles etc. 
@@ -3494,6 +3523,9 @@ def plot_acs_hazard_4pp(
         around the centre, eg for future temperature anomalies with a larger
         positive range compared to the negative range.
 
+    show_copyright: bool
+        Default True
+
     Returns
     -------
     A four panel plot saved as a png in a "figures" file in your working directory.
@@ -3584,7 +3616,9 @@ def plot_acs_hazard_4pp(
                                 outfile=outfile,
                                 savefig=savefig,
                                 tick_rotation=tick_rotation,
-                                vcentre=vcentre,)
+                                vcentre=vcentre,
+                                show_copyright=show_copyright,
+                                )
 
     
 
@@ -3652,6 +3686,7 @@ def plot_acs_hazard_1plus3(
                 orientation="vertical",
                 tick_rotation=None,
                 vcentre=None,
+                show_copyright=True,
             ):
     """
     Four panel plot with 1 baseline plot and 3 future scenario 
@@ -3971,6 +4006,9 @@ def plot_acs_hazard_1plus3(
         around the centre, eg for future temperature anomalies with a larger
         positive range compared to the negative range.
 
+    show_copyright: bool
+        Default True
+
     Returns
     -------
     A four panel plot (one baseline and three anomalies) saved as a png 
@@ -4184,7 +4222,7 @@ def plot_acs_hazard_1plus3(
                         ax=ax111,
                         text_xy = text_xy,
                         title_ha = "center",
-                        orientation = orientation,
+                        show_copyright=show_copyright,
                    )
     # draw border
     # ax111.axis(True)
diff --git a/example_notebooks/acs_plotting_maps_examples.ipynb b/example_notebooks/acs_plotting_maps_examples.ipynb
