CLI reference¶

xemc3-append-time - CLI interface¶

Load the data from EMC3 simulations and store as netcdf file. The data is appended for each simulation to the netcdf file, which will be created if it does not yet exists.

xemc3-append-time [-h] [-q] [-o NAME] [-V] path [path ...]

xemc3-append-time positional arguments¶

path -
Path of the directory to load. The netcdf file will be
called dir.nc if the folder was called dir.

xemc3-append-time options¶

-h, --help - show this help message and exit
-q, --quiet - Be less verbose
-o NAME, --name NAME - Specify the name for the output file. Defaults to dir.nc when not given. Otherwise name.nc is used.
-V, --version - show program’s version number and exit

xemc3-to-netcdf - CLI interface¶

Load the data from EMC3 simulations and store as netcdf file. The data is written for each simulation to a netcdf file.

xemc3-to-netcdf [-h] [-q] [-o NAME] [-V] [--ignore-broken] path [path ...]

xemc3-to-netcdf positional arguments¶

path -
Path of the directory to load. The netcdf file will be
called dir.nc if the folder was called dir.

xemc3-to-netcdf options¶

-h, --help - show this help message and exit
-q, --quiet - Be less verbose
-o NAME, --name NAME - Specify the name for the output file. Defaults to dir.nc when not given. Otherwise name.nc is used.
-V, --version - show program’s version number and exit
--ignore-broken - Ignore if mapped files are incomplete

xemc3-divertor - CLI interface¶

Plot the heatflux on the divertor

xemc3-divertor [-h] [-c] [-s] [-a] [-l] [-q] [-g] [-r RANGE] [-t TITLE] [--phi_slices]
               [-k KEY] [-V]
               path

xemc3-divertor positional arguments¶

path - Path of data

xemc3-divertor options¶

-h, --help - show this help message and exit
-c, --cutoff - Show only tile with high target power flux
-s, --plotsym - Plot assuming stellarator symmetry
-a, --plotall - Plot all 5 segments
-l, --plotlower - Plot only the lower half
-q, --quiet - Be less verbose
-g, --gui - Start the gui
-r RANGE, --range RANGE - Set datarange (default: )
-t TITLE, --title TITLE - Title for plot
--phi_slices - Show where phi in deg is an integer
-k KEY, --key KEY - Data to plot (default: Energy flux)
-V, --version - show program’s version number and exit

xemc3-to-archive - CLI interface¶

Archive the data from EMC3 simulations as a netcdf file.

xemc3-to-archive [-h] [-q] [-o NAME] [-V] [-g] [-n] [-d] path [path ...]

xemc3-to-archive positional arguments¶

path -
Path of the directory to load. The netcdf file will be
called dir.arch.nc if the folder was called dir.

xemc3-to-archive options¶

-h, --help - show this help message and exit
-q, --quiet - Be less verbose
-o NAME, --name NAME - Specify the name for the output file. Defaults to dir.arch.nc when not given. Otherwise name.arch.nc is used.
-V, --version - show program’s version number and exit
-g, --geometry - Also store geometry
-n, --no-mapping - Do not include the mapping information.
-d, --delete - Delete the uncompressed input file. Only used if the input was a netcdf file