Archive Handlers (nips.archives)

This module includes all functions that are needed to set-up and use the nips archive. Before running the pipeline or using any archive functions the archive has to be initiated by running the f_new() function:

# =======================================================================
# Generating the database
# =======================================================================
archive_database.f_new(archive_name, database_name, path=archive_path, overwrite=True)

A wrapper to run this script is provided in (nipsexamples) and described here

nips.archives Package

The nips.archives module contains the archive management classes for the nips package.

Functions

f_analyse_exposure_folder(folder_name[, …])	Method to scan an exposure folder searching for count-rate maps and analyse the results This method scans the archive folder, looking ofr daily folders (format ‘DayYYYYNNN’).
f_find_exposure_folders(nid[, env, path, logger])	Method to find the exposure folder(s) associated to a given NID.
f_get_env(pipeline_id, jlab_id)	Get the environment variable associated to a pair of pipeline and JLAB IDs.
f_get_obs_id(folder_name[, …])	Method returning the OBS_ID keyword value associated to a given folder name.
f_new(archive_name, database_name[, path, …])	Method to create a new database file associated to an archive.
f_scan_archive(archive_name[, path, …])	Method to scan a full archive folder.
f_scan_daily_folder(daily_folder_name[, …])	Method to scan a daily folder for exposure folders.
f_scan_exposure_folder(folder_name[, path, …])	Method to scan an exposure folder searching for count-rate maps.
f_split_daily_folder_name(daily_folder_name)	Method to split a daily folder name into its basic tokens.
f_split_exposure_name(file_name)	Method to split a processed exposure file name into its basic tokens.
f_split_folder_name(folder_name)	Method to split an exposure folder name into its basic tokens.

Classes

Database([logger_id])

Class for the handling of the archive database.

Class Inheritance Diagram