This package is in active development, and acts as a wrapper around the Field Line Universal relaXer (FLUX), a solar magnetic field model. This means that it requires the FLUX perl/C software located on Github.
Instructions for installation on Linux or on Macos can be found in the main FLUX repo here.
Editing the configuration file by running the flux-config-edit command is one of the primary ways to interface with the code. The file can also be edited directly. The second line of the config file selects which profile that fluxpype will use. Any settings not redefined in that profile will use the default settings from the first block ("DEFAULT").
To see the details of the current job configuration:
flux-config-view
To edit the details of the configuration, modify config.ini. You can find that by typing:
flux-config-edit
The pipe can be invoked in four ways.
% flux-config-run
% python3 fluxpype/config_runner.py
% python3 fluxpype
% python3
>>> from fluxpype.config_runner import run
>>> run()
This project welcomes contributions and suggestions. For details, visit the repository's Contributor License Agreement (CLA) and Code of Conduct pages.