Running PySight (main module)

Generally you’ll want to use pysight.main.run as the standard\default way to run this application. It can be run without any arguments, which will open the GUI, or run with a pre-existing configuration file name.

The other two functions allow you to run PySight on several list files one after the other, either in a sequential manner (pysight.main.run_batch_lst()) or in a parallel manner (pysight.main.mp_batch()).

pysight.main.run(cfg_file: str = None) → Optional[pysight.nd_hist_generator.outputs.PySightOutput][source]

Run PySight.

Parameters:cfg_file (str) – Optionally supply an existing configuration filename. Otherwise a GUI will open.
Return PySightOutput:
 Object containing raw and processed data
pysight.main.run_batch_lst(foldername: str, glob_str: str = '*.lst', recursive: bool = False, cfg_file: str = '') → pandas.core.frame.DataFrame[source]

Run PySight on all list files in the folder

Parameters:
  • foldername (str) –
    • Main folder to run the analysis on.
  • glob_str (str) – String for the glob function to filter list files
  • recursive (bool) – Whether the search should be recursive.
  • cfg_file (str) – Name of config file to use
Return pd.DataFrame:
 

Record of analyzed data
pysight.main.mp_batch(foldername, glob_str='*.lst', recursive=False, n_proc=None, cfg_file: str = '')[source]

Run several instances of PySight using the multiprocessing module.

Parameters:
  • foldername (str) – Folder to scan
  • glob_str (str) – Glob string to filter files
  • recursive (bool) – Whether to scan subdirectories as well
  • n_proc (int) – Number of processes to use (None means all)
  • cfg_file (str) – Configuration file name