/pytdm

Primary LanguagePythonMIT LicenseMIT

version pythonversion

pyTDm : Python tool to initialize a TDm flux rope in a simulation

Welcome to pytdm !

This python module initializes a modified Titov-Démoulin (Titov et al. 2014) flux rope and writes it in a PLUTO AMR data file. (Mignone et al. 2012)

There is currently (October 2022) work to extend that module to be able to add the TDm in the static version of PLUTO and also in the COCONUT coronal model.

The code reads the TDm.config file (which contains the different parameters of the TDm) and add it to the corresponding datafile.

If anyone is interested in using this module please send an email to fl.regnault@gmail.com so that you can be helped in how to use this module in the most efficient way.

Installation

git clone https://github.com/fregnault/pyTDm.git
cd pyTDm
pip3 install .

Basic usage

To see an example of the insertion of a TDm flux rope in a PLUTO AMR datafile see the pluto_amr example directory.

Incoming features

  • Right now the module can add a TDm flux rope in a COCONUT simulation with the add_TDm_coconut but this has not been fully validated yet.
  • There is ongoing work in inserting the TDm in a dbl file of a static grid with the PLUTO simulation

Acknowlegdments

The pyPLUTO.py used is this module was written by B. Vaidya and then modified by A. Strugarek, B. Perri and V. Réville.

A. Strugarek significantly contributed to the writing and reviewing of this python module.