Analysis_Project

Class for analysis, this the main class which makes objects to define the analysis following the workflow of the Wisconsin Department of Natural Resources. This class combines multiple Well objects, each of which contains one or more WellResponse objects. The AnalysisProject object is instantiated using a yaml configuration file.

class pycap.analysis_project.Project(ymlfile, write_results_to_files=True, project_dict=None)

Bases: object

Highest-level Class for a well drawdown and/or depletion analysis. This Class is developed for the specific analysis needs of the Wisconsin Department of Natural Resources and was initially created to reproduce the logic and results of an internal, spreadsheet-driven workflow. This workflow may also serve as an example template for other users.

Parameters

ymlfile: string or pathlib.Path

Path to a yml file containing configuration information for a project. If None, project is initiated from the project_dict arg, if present. If both are None, throw an error.

write_results_to_files: Bool

True means all output files are written to disk. False means results are only held in memory and not written. Default is True

project_dict: dictionary

Dictionary containing all the data from a yml configuration. Only read if ymlfile is None. This option is to allow an in-memory-only driving of the project to avoid any interaction with the disk.

aggregate_results()

Aggregate all results from the Project

report_responses()

make a report file - named from the YML name

write_responses_csv()

Write all responses to an external CSV file