Open-source Flux Transport (OFT) is a software suite for generating full-Sun magnetograms through acquiring & processing observational data, generating realistic convective flows, and running them through a surface flux transport (SFT) model.
OFT includes the data acquisition/mapping code MagMAP, the convective flow generation code ConFlow, and the surface flux transport code HipFT as submodules.
Check out the repository using git's recursive option:
git clone https://github.com/predsci/oft --recursive
If forgotten, initialize the submodules with:
git submodule update --init
When pulling updates, to ensure you get the submodule updates as well, use:
git pull --recurse-submodules
Once you have the OFT repository with its submodules, follow the instructions in each submodule to install them.
All executables/scripts need to be in your PATH for OFT to work.
For BASH, we have provided a script that can be sourced to do this:
. ./load_oft_env.sh
The script can also be used as a reference for making an equivalent script for other shells.
First, make sure all OFT tools and scripts are in your PATH (see above).
OFT has three main components:
- MagMAP: Obtain, process, and map HMI magnetograms, and prepare them for data assimilation in HipFT
- ConFlow: Generate a sequence of convective flows for use in HipFT
- HipFT: The flux transport model.
Depending on the use case, using MagMAP and/or ConFlow are optional (for example, when running HipFT without HMI data assimilation and/or without convective flows).
A sample data set generated using MagMAP and Conflow is provided in the zenodo pacakge:
HipFT Sample Input Dataset for Convective Flows and Data Assimilation
More details on running the full sequence of OFT will be added here later.
In the mean time, see the run instructions in each submodule folder's README for further information.