pyatran.output.Result

class pyatran.output.Result(path)[source]

Reading SCIATRAN’s DATA_OUT directory.

The Result class reads output from SCIATRAN’s DATA_OUT directory and stores the results in pandas data structures.

Parameters:

path : str

Path to the DATA_OUT directory of the SCIATRAN run. This can be either an actual filesystem path to the DATA_OUT directory, or it can be the filename of a .zip file containing the DATA_OUT (i.e., there has to be a folder DATA_OUT at the root of the .zip file) directory.

Notes

Creating an instance of the Result class automatically reads all available information from path; i.e., no explicit calling of the read_* methods is necessary.

Currently, only the following SCIATRAN output files can be read:

  • SCE_ABSORBER.OUT
  • SCE_SUMMARY.OUT
  • aer_abs.dat
  • aer_sca.dat
  • amf.dat
  • bamf_int.dat
  • block_amf.dat
  • cld_abs.dat
  • cld_sca.dat
  • gas_abs.dat
  • height.dat
  • intensity.dat
  • intensity_noring.dat
  • irradiance.dat
  • output_map.inf
  • profiles_nd.dat
  • profiles_vmr.dat
  • ray_sca.dat
  • ring.dat
  • slant_col.dat
  • tg_vod.dat
  • vod_all.dat
  • wf_*.dat

Methods

clear()
copy()
fromkeys($type, iterable[, value]) Returns a new dict with keys from iterable and values equal to value.
get(k[,d])
items()
keys()
pop(k[,d]) If key is not found, d is returned if given, otherwise KeyError is raised
popitem() 2-tuple; but raise KeyError if D is empty.
read_SCE_ABSORBER()
read_SCE_SUMMARY()
read_amf(filename)
read_block_amf()
read_intensity([filename])
read_irradiance()
read_local_optical_parameters()
read_output_map()
read_profiles(qty)
read_slant_col()
read_tg_vod()
read_vod_all()
read_wf(fn)
setdefault(k[,d])
update([E, ]**F) If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()
__init__(path)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(path) Initialize self.
clear()
copy()
fromkeys($type, iterable[, value]) Returns a new dict with keys from iterable and values equal to value.
get(k[,d])
items()
keys()
pop(k[,d]) If key is not found, d is returned if given, otherwise KeyError is raised
popitem() 2-tuple; but raise KeyError if D is empty.
read_SCE_ABSORBER()
read_SCE_SUMMARY()
read_amf(filename)
read_block_amf()
read_intensity([filename])
read_irradiance()
read_local_optical_parameters()
read_output_map()
read_profiles(qty)
read_slant_col()
read_tg_vod()
read_vod_all()
read_wf(fn)
setdefault(k[,d])
update([E, ]**F) If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()