gt-frc / gt3

The Georgia Tech Tokamak Transport Code (GT3). Also known as GTEDGE2.

Installation

Using pip

$ pip install GT3

Installing from GitHub

• Master branch

Clone GT3 master branch from github

$ git clone https://github.com/gt-frc/gt3.git

• Other branches

You can clone another branch from github as follows:

$ git clone -b <branch> https://github.com/gt-frc/gt3.git

Installing Branches from GitHub via pip

To use pip to install a development version of GT3, simply use

$ pip install git+https://github.com/gt-frc/gt3@development

Neutrals Calculations

GT3 utilizes NeutPy (https://github.com/gt-frc/neutpy) for the calculation of neutral particles recycling from the wall. Neutpy is an optional dependency. NeutPy also requires the Triangle 2D meshing package (see the NeutPy github for details).

To install NeutPy:

$ pip install neutpy

Usage

GT3 can be run in 2 different ways: via a config file and profiles or via a test data class.

• From Files

The primary method of running GT3 is via the gt3 class

from GT3 import gt3

If neutpy is installed, you'll see a message indicating that it is being imported. Otherwise, a warning will be given. If you will be running neutpy, the main configuration file needs to be placed in the CWD. A sample configuration file can be found on the neutpy github as neutpy.conf

GT3 is instantiated in this manner by providing an input file.

myPlasma = gt3(inputFile="myInputFile")

See the /inputs directory for example input files (generally called togt3_d3d_shotid_timeid). The inputFile argument takes a file relative to the current working directory (CWD). An input file will include some plasma parameters and meshing information. In addition, the locations of 1D and 2D profile data are entered into this file. The locations also must be relative to the CWD. See the inputs directory for an example with DIII-D shot 144977.3000.

GT3 includes various modules that provide information and calculations about the plasma. Running gt3() with the mode argument will run different sets of modules (see gt3.py for a list of modes). Modules can also be run using the various arguments (run_IOL(), run_NBI(), run_radial_transport(), etc.).

To run the full radial transport code, use the mode='radialtrans' argument in gt3() or run myPlasma.run_radial_transport().

• From A Class

Documentation Coming Soon

gt3's Issues

Supress annoying output from fortran dependencies.

Benchmark radial transport calculations

Radial electric field calculation in rtrans has potentially unphysical izn_rate in denominator

In CalcErIOL.py, the ionization rate is required in the "iol_term". When there are no neutrals, this term will blow up. Need to suss out what physically is going on here.

Implement better exeption handling (raise warnings instead of print statements). Should also implement logging.

Summary method request

It would be useful to have a method in GT3 that prints a summary of all the input variables and possibly other relevant information. Maybe toss it in the gt3 class and use a table generator class. I think one is in neutpy.

Basic unit testing should be added

GT3 current does not have any real unit testing. Should attempt to support.

Gradient scale lengths for 2D profiles are not correct

The gradient scale lengths calculated for 2D profiles are not done correctly. As a temporary fix, we take the FSA, find the scale length of that, and broadcast back to 2D.

Extend 2D values to have a .to1D() method, possibly via decorators

2D values are often tricky because you need to know that they are 2D and you need to remember the weird [:,0] code. I think it would be a good idea to extend 2D profiles to have 1D methods for bringing variables to 1 dimension.

Clean up and extend GT3plots

ReadInFile shouldn't use exec since it's not necessary

ReadInFile's way of setting instance variables is unnecessary and should be done as it was done in NeutPy.

Pythonize NBEAMS

Make GT3 pip installable

Improve docstrings

• read_infile
• core
• iol
• imp_rad
• neutrals
• beamdep
• rad_trans
• thermal_inst

Convert ADPAK to python binary and rewrite driver in python

Plasma slamming needs to modify calculation of plasma radius

When the LCFS hits a wall, we lose the ability to X-point physics and have to manually set a separatrix. One problem is that we have to decide what the plasma radius becomes. Code is being changed to manually take the left-most R value from the wall_line LineString as the lowest value the inboard midplane can be. Probably need to make this change for other geometries and triangularities.

Make NeutPy an optional dependency

Currently, GT3 requires neutpy to be installed. Since neutpy is fairly extensive, it might be better to have it as an optional dependency. Should be easy to do since RadialTransport has exception handling if it can't find neutrals data.

Provide a way to get a shot summary

It would be useful to have a method in GT3 that prints a summary of all the input variables and possibly other relevant information. Maybe toss it in the gt3 class and use a table generator class. I think one is in neutpy.

Move individual script stuff out of gt3.py

ReadInFile is throwing errors when trying to read in the neutrals output file since it's in JSON format

The output neutrals data file is in JSON format. ReadInFile still tries to read this in and throws errors when it sees JSON data. Probably just need to not even look for this file in the data input routine.

matplotlib._cntr is deprecated

As of matplotlib 2.2.0 _cntr has been deprecated (flatironinstitute/CaImAn#174)

They recommend replacing with contours module. Is this an easy fix?

Allow core to handle 2 x points

Currently, GT3 cannot handle 2 X points.

Improvements to X-Miller