Merge branch 'main' of https://github.com/ssc-maire/AniMAIRE-public i…

…nto main

CITATION.cff

@@ -6,6 +6,7 @@ authors:
   orcid: "https://orcid.org/0000-0002-8096-1383"
 - family-names: "Lei"
   given-names: "Fan"
+  orcid: "https://orcid.org/0000-0002-4365-988X"
 - family-names: "Baird"
   given-names: "Fraser"
   orcid: "https://orcid.org/0000-0002-8437-7440"
@@ -16,7 +17,7 @@ authors:
   given-names: "Clive"
   orcid: "https://orcid.org/0000-0002-3778-9821"
 title: "AniMAIRE-public"
-version: 1.1.3
+version: 1.1.6
 doi: 10.5281/zenodo.10992643
-date-released: 2024-04-18
+date-released: 2024-04-22
 url: "https://github.com/ssc-maire/AniMAIRE-public"

README.md

@@ -223,26 +223,7 @@ Any particular altitudes the user wants to use can be supplied to `altitudes_in_
 If you want to perform calculations only at a specific set of latitudes and longitudes you should use the `array_of_lats_and_longs` argument, supplying it as a 2 dimensional `list` or numpy array, where the first column refers to latitudes and the second column refers to longitudes. All longitudes in this case should be specified in terms of longitude east (i.e. 0.00 degrees - 359.99 degrees). **Using the `array_of_lats_and_longs` argument significantly speeds up the running of `AniMAIRE` if you're only interested in a small number of coordinates, so its use is highly recommended in those situations.**
 
 There are many ways you could plot this data. Several example functions,`plot_dose_map` and `create_single_dose_map_plotly`, have been supplied in `AniMAIRE` that uses matplotlib or plotly to plot the dose rates across Earth (i.e. as a function of latitude and longitude) at a given altitude. Both of these functions are available in the `dose_plotting` submodule supplied with AniMAIRE. Their specifications are the following:
-<<<<<<< HEAD
-<<<<<<< HEAD
-=======
-=======
->>>>>>> 8cd0505f6cee775badf8f4abb25e70ae2c943777
-
-```
-def plot_dose_map(map_to_plot,
-                  plot_title=None,
-                  plot_contours=True,
-                  levels=3,
-                    **kwargs)
-```
-for matplotlib plots, where map_to_plot is the Pandas DataFrame outputted by a run of `AniMAIRE`, with only one altitude selected. `plot_contours` can be switched on or off to control whether contours are added to the plot, and `levels` can be used to specify to number of contours and/or dose rates for the contours to correspond to. `hue_range` can also be supplied with a 2-value tuple to specify the limits of the colorbar to be plotted with the plot. 
-<<<<<<< HEAD
->>>>>>> 8cd0505f6cee775badf8f4abb25e70ae2c943777
-
-To generate a plotly plot, you can run 
 ```
-<<<<<<< HEAD
 def plot_dose_map(map_to_plot,
                   plot_title=None,
                   plot_contours=True,
@@ -251,15 +232,8 @@ def plot_dose_map(map_to_plot,
 ```
 for matplotlib plots, where map_to_plot is the Pandas DataFrame outputted by a run of `AniMAIRE`, with only one altitude selected. `plot_contours` can be switched on or off to control whether contours are added to the plot, and `levels` can be used to specify to number of contours and/or dose rates for the contours to correspond to. `hue_range` can also be supplied with a 2-value tuple to specify the limits of the colorbar to be plotted with the plot. 
 
-To generate a plotly plot, you can run 
-```
-=======
->>>>>>> 8cd0505f6cee775badf8f4abb25e70ae2c943777
-=======
-
-To generate a plotly plot, you can run 
+To generate a plotly plot, you can run
 ```
->>>>>>> 8cd0505f6cee775badf8f4abb25e70ae2c943777
 def create_single_dose_map_plotly(DF_to_use,
                                 selected_altitude_in_km)
 ```

setup.py

@@ -23,7 +23,7 @@
     package_data={"AniMAIRE":[
                                 "anisotropic_MAIRE_engine/data/*.csv"
                                          ]},
-    version='1.1.3',
+    version='1.1.6',
     description='Python library for running the anisotropic version of MAIRE+',
     long_description=long_description,
     long_description_content_type='text/markdown',