install_indices

cherab.lhd.emc3.repository.install.install_indices(path: Path | str, grid_file: Path | str = PosixPath('/home/docs/.cache/cherab/lhd/emc3/grid-360.nc')) → NoneSource

Install EMC3-EIRENE cell indices into netCDF file.

There are many types of ways to apply an index into several cells of EMC3-EIRENE. We have three types of indices: physics, geometry, and coarse indices currently.

The physics index is the index for use in the calculation of the physics quantity by EMC3-EIRENE. The geometry index is the index specifying each cell for several zones. The coarse index is the index for the coarse grid.

Parameters:

pathPath | str

Path to the original text file written about physics cell indices (e.g. CELL_GEO).

grid_filePath | str, optional

Path to the grid netCDF file, by default cherab/lhd/emc3/grid-360.nc under the user’s cache directory.