nasa / Kamodo

Other
50 stars 25 forks source link

Kamodo-Tsyganenko tool addition #142

Closed ffejj closed 5 months ago

ffejj commented 6 months ago

Ensemble has added a Kamodo-Tsyganenko model reader; the Kamodo object that's built can query for instantaneous magnetic field readings, as well as the relevant driver data. We conduct Field Line Tracing to plot the streamlines of the magnetic output.

The tool is constructed using Docker; to build, clone this repo and navigate to the relevant working directory:

cd Kamodo/kamodo_ccmc/readers/kamodo-tsyganenko

Then build and run the container:

docker compose build tsyganenko
docker compose up initialize
docker compose up tsyganenko

To instantiate the object:

from kamodo_geopack.tsyganenko import KTsyganenko, to_utc
kt = KTsyganenko(coord_out='GSM', coord_in='GSE')
kt

More directions for manipulating the object are found in the relevant README.md.