This repository provides an implementation of the HUXt model (Heliospheric Upwind Extrapolation with time dependence) in Python, as described by Owens et al. (2020). This is a simple 1D incompressible hydrodynamic model, which essentially solves Burgers equation using the upwind numerical scheme. For more details on the models background, refer to Owens et al. (2020).
HUXt is written in Python 3.7.3 and has a range of dependencies, which are listed in the requirements.txt and environment.yml files. Because of these dependencies, the simplest way to work with HUXt in conda is to create its own environment. With the anaconda prompt, in the root directory of HUXt, this can be done as:
>>conda env create -f environment.yml
>>conda activate huxt
Then the examples can be accessed through
>>jupyter lab code/HUXt_example.ipynb
Please note that after cloning or downloading HUXt, users should update code/config.dat so that root points to the local directory where HUXt is installed. Otherwise HUXt won't know the file locations for saving and loading figures and data.
Some examples of how to use HUXt can be found in HUXt_example.ipynb.
HUXt requires an inner boundary condition for longitudinal solar wind speed profile. This can either be prescribed by the user or derived from other sources. For convenience, huxt_inputs.py provides some functions for downloading and generating longitudinal solar wind speed profiles from the HelioMAS solutions (an example is provided in the examples workbook). Routines for plotting and animating HUXt solutions can be found in huxt_analysis.py. Again, examples are provided in the workbook.
Please contact either Mathew Owens or Luke Barnard.
Please cite this software as Owens et al. (2020), A Computationally Efficient, Time-Dependent Model of the Solar Wind for Use as a Surrogate to Three-Dimensional Numerical Magnetohydrodynamic Simulations, Sol Phys, DOI: 10.1007/s11207-020-01605-3