resistics.project.io module¶

resistics.project.io.loadProject(projectPath: str, configFile: str = '') → resistics.project.data.ProjectData[source]¶

Load an existing project

Parameters

projectPathstr: Path for the project directory
configFilestr: Path to a configuration file

Returns

ProjectData: A project data object

resistics.project.io.loadProjectFile(filepath: str) → None[source]¶

Load project from path to project file

Parameters

filepathstr: Path to project file

Returns

projPathDict[str, Union[str, datetime]]: A dictionary with various project paths

resistics.project.io.newProject(projectPath: str, refTime: Union[str, datetime.datetime], configFile: str = '', name: str = 'mtProj') → resistics.project.data.ProjectData[source]¶

Create a new project in project path

A new project will be created in project path. If the project path directory does not exist, a new one will be made. If a project already exists in project path, this project will be loaded and returned.

Parameters

projectPathstr: Path for the project directory
refTimedatetime: The reference time for the project
configFilestr, optional: Path to a configuration file
namestr, optional (default is “mtProj”): The name of the project file

Returns

ProjectData: A project data object

resistics.project.io.saveProjectFile(filepath: str, refTime: datetime.datetime, calPath: str, timePath: str, specPath: str, statPath: str, maskPath: str, transFuncPath: str, imagePath: str) → None[source]¶

Save the project file to filepath

Parameters

filepathstr: Path to project file