Skip to content

Commit

Permalink
added lots of files relating to data and figures from the paper about…
Browse files Browse the repository at this point in the history
… AniMAIRE that will be published, so that the data will be storage for future potential usage by others who read the paper. Also modified things so that these files can be used as examples to anyone wanting to do replication of the work.
  • Loading branch information
ChrisSWDavis committed Apr 22, 2024
2 parents 6be7e6e + f0c160f commit 2c502b4
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ 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
=======

```
def plot_dose_map(map_to_plot,
Expand All @@ -232,9 +234,23 @@ def plot_dose_map(map_to_plot,
**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.
>>>>>>> 8cd0505f6cee775badf8f4abb25e70ae2c943777
To generate a plotly plot, you can run
```
<<<<<<< HEAD
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.

To generate a plotly plot, you can run
```
=======
>>>>>>> 8cd0505f6cee775badf8f4abb25e70ae2c943777
def create_single_dose_map_plotly(DF_to_use,
selected_altitude_in_km)
```
Expand Down

0 comments on commit 2c502b4

Please sign in to comment.