tapsap.file_io package
Submodules
tapsap.file_io.experiment_to_df module
- tapsap.file_io.experiment_to_df.experiment_to_df(experiment_data: Experiment) DataFrame
This function takes a experiment class and returns a data frame.
- Args:
experiment_data (class Experiment): A Experiment data class.
- Returns:
experiment_df (DataFrame): The experiment_data as a data frame.
- Implementor:
Ross Kunz
- Link:
None
tapsap.file_io.reactor_to_df module
tapsap.file_io.read_tdms module
- tapsap.file_io.read_tdms.read_tdms(file_name: str) Experiment
A function for reading a tdms file to a tapsap Experiment object. Requires the use of the python package ‘nptdms’ for use.
- Args:
file_name (str): The path to the TDMS file that is to be read.
- Returns:
experiment (Experiment): A object containing all of the TDMS information.
- Citation:
None
- Implementor:
Ross Kunz
- See also:
tapsap.file_io.Experiment
tapsap.file_io.Transient
- Link:
None
tapsap.file_io.read_xlsx module
- tapsap.file_io.read_xlsx.read_xlsx(file_name: str) Experiment
A function for reading an excel file to a tapsap Experiment object.
- Args:
file_name (str): The path to the TDMS file that is to be read.
- Returns:
experiment (Experiment): A object containing all of the TDMS information.
- Citation:
None
- Implementor:
Ross Kunz
- See also:
tapsap.file_io.Experiment
- Link:
None
tapsap.file_io.transient_to_xlsx module
- tapsap.file_io.transient_to_xlsx.transient_to_xlsx(species_data: Transient) DataFrame
This function takes a Transient class and returns the information flux, concentration, rate information into a data frame. The final option (excel_format) includes the temperature as well as the other gas information such as name, mass and gain ect.
- Args:
species_data (class Transient Series): A collection of transient information used to describe a gas species.
excel_format (bool): Returning a data frame that can be exported to excel including temperature, name, mass, ect.
- Returns:
gas_df (DataFrame): The species_data as a data frame.
- Implementor:
Ross Kunz
- Link:
None
tapsap.file_io.transient_to_xlsx_summary module
- tapsap.file_io.transient_to_xlsx_summary.transient_to_xlsx_summary(species_data: Transient) DataFrame
This function takes a Transient class dataframe of moment information into a excel style data frame. The final option (excel_format) includes the temperature as well as the other gas information such as name, mass and gain ect.
- Args:
species_data (class Transient Series): A collection of transient information used to describe a gas species.
excel_format (bool): Returning a data frame that can be exported to excel including temperature, name, mass, ect.
- Returns:
gas_df (DataFrame): The species_data as a data frame.
- Implementor:
Ross Kunz
- Link:
None
tapsap.file_io.write_xlsx module
- tapsap.file_io.write_xlsx.write_xlsx(experiment: Experiment, output_file_name: str = 'results.xlsx', data_type: str = 'flux') None
This function converts a TAP Experiment object to an Excel spread sheet.
- Args:
experiment (class Experiment): The Experiment class from tapsap holding all of the kinetic information.
data_type (str): A string containing which type of information you would like to save. Options: flux, summary
output_file_name (str): The path in which you would like to save the excel document.
- Returns:
None
- Citation:
None
- Implementor:
Ross Kunz