Full release of ability to run AniMAIRE without Magnetocosmics - using OTSO asymptotic direction files as input files for AniMAIRE

[ChrisSWDavis]

Full Changelog: v1.1.10...v1.2.2

Full release of ability to use OTSO asymptotic direction files as input files for AniMAIRE

By popular demand, manual file input for asymptotic directions is now enabled for AniMAIRE. Previously AniMAIRE required a Magnetocosmics installation to run, but Magnetocosmics has been challenging to find and install for users, particularly if they aren't in a European Space Agency-affiliated country. Now users are able to generate asymptotic directions using the open source OTSO Python software and feed these into AniMAIRE to produce dose rates. This should significantly improve the accessability of AniMAIRE to the scientific community, and in principle allow anyone in the world to use the combination of OTSO and AniMAIRE to perform simulations of dose rates in the atmosphere during major space weather events.

I've updated the README with details of how to run AniMAIRE directly from asymptotic direction files. Currently the system for doing this is somewhat basic - it should work for any purposes that a user needs, but there are probably usability improvements that could be made in the future to make input from files more modular and/or easier to use. Feel free to post an issue or in the discussion channel if you have questions, thoughts, ideas or issues with using this running mode for AniMAIRE.

Other improvements made in this update

• Lots of minor bug fixes
• Reduced the memory usage of outputted dose rate dataframes massively, by making full output details in attributes optional
• Made lots of improvements to the code internal documentation, for instance adding lots of docstrings and type hinting
• Added many more unit tests, to confirm the safety of changes made to the code

---

This discussion was created from the release Full release of ability to run AniMAIRE without Magnetocosmics - using OTSO asymptotic direction files as input files for AniMAIRE.