API Documentation¶
This is the API documentation of pyatran:
pyatran.input¶
Handling of SCIATRAN input files:
- extraction of input file information from runtime configurations
- copying input files to new directories
- adapting runtime configurations to reflect new directory structure
save_input_files(cfg, path) |
Copy SCIATRAN input files into runtime directory. |
pyatran.output¶
Reading SCIATRAN output from the DATA_OUT directory into pandas
data structures.
read_sciatran_output(path[, absorbers, …]) |
Read SCIATRAN output |
read_inp_par(fn, par) |
Read one parameter from SCE_INP_PARS.OUT |
read_xsection_data(fn_pars) |
Read SCIATRAN input cross-sections |
rename_species(dataset, new_names) |
Rename a species in an output Dataset |
Result(path) |
Reading SCIATRAN’s DATA_OUT directory. |
pyatran.params¶
Creation of SCIATRAN control files from JSON.
json_to_sciatran(cfg, path) |
Write SCIATRAN configuration. |
load_json(filename) |
Load SCIATRAN configuration from JSON file. |
pyatran.runtime¶
Running SCIATRAN
run_sciatran(runpath, executable) |
Run SCIATRAN. |
setup_runtime(cfg, sciaexec[, dirname, …]) |
Setup a runtime directory for SCIATRAN. |
store_results(runpath, target[, …]) |
Store SCIATRAN runtime in ZIP format. |
rotate_log(runpath[, filename]) |
Rotate SCIATRAN log files out of the way |