welltestpy.data.Campaign

class Campaign(name, fieldsite='Fieldsite', wells=None, tests=None, timeframe=None, description='Welltest campaign')

Bases: object

Class for a well based campaign.

This is a class for a well based test campaign on a field site. It has a name, a description and a timeframe.

Parameters

• name (str) – Name of the campaign.

• fieldsite (str or Variable, optional) – The field site. Default: "Fieldsite"

• wells (dict, optional) – The wells within the field site. Keys are the well names and values are an instance of Well. Default: None

• wells (dict, optional) – The tests within the campaign. Keys are the test names and values are an instance of Test. Default: None

• timeframe (str, optional) – Timeframe of the campaign. Default: None

• description (str, optional) – Description of the field site. Default: "Welltest campaign"

Attributes

fieldsite

FieldSite: Field site where the campaign was realised.

tests

dict: Tests within the campaign.

wells

dict: Wells within the campaign.

Methods

add_well(name, radius, coordinates[, ...])	Add a single well to the campaign.
addtests(tests)	Add some specified tests.
addwells(wells)	Add some specified wells.
deltests(tests)	Delete some specified tests.
delwells(wells)	Delete some specified wells.
diagnostic_plot(pumping_test, ...)	Generate a diagnostic plot.
plot([select_tests])	Generate a plot of the tests within the campaign.
plot_wells(**kwargs)	Generate a plot of the wells within the campaign.
save([path, name])	Save the campaign to file.

add_well(name, radius, coordinates, welldepth=1.0, aquiferdepth=None)

Add a single well to the campaign.

Parameters

• name (str) – Name of the Variable.

• radius (Variable or float) – Value of the Variable.

• coordinates (Variable or numpy.ndarray) – Value of the Variable.

• welldepth (Variable or float, optional) – Depth of the well. Default: 1.0

• aquiferdepth (Variable or float, optional) – Depth of the aquifer at the well. Default: "None"

addtests(tests)

Add some specified tests.

This will add tests to the campaign.

Parameters

tests (dict) – Tests to be added.

addwells(wells)

Add some specified wells.

This will add wells to the campaign.

Parameters

wells (dict) – Wells to be added.

deltests(tests)

Delete some specified tests.

This will delete tests from the campaign. You can give a list of tests or a single test by name.

Parameters

tests (list of str or str) – Tests to be deleted.

delwells(wells)

Delete some specified wells.

This will delete wells from the campaign. You can give a list of wells or a single well by name.

Parameters

wells (list of str or str) – Wells to be deleted.

diagnostic_plot(pumping_test, observation_well, **kwargs)

Generate a diagnostic plot.

Parameters

• pumping_test (str) – The pumping well that is saved in the campaign.

• observation_well (str) – Observation point to make the diagnostic plot.

• **kwargs – Keyword-arguments forwarded to campaign_well_plot().

plot(select_tests=None, **kwargs)

Generate a plot of the tests within the campaign.

This will plot an overview of the tests within the campaign.

Parameters

• select_tests (list, optional) – Tests that should be plotted. If None, all will be displayed. Default: None

• **kwargs – Keyword-arguments forwarded to campaign_plot()

plot_wells(**kwargs)

Generate a plot of the wells within the campaign.

This will plot an overview of the wells within the campaign.

Parameters

**kwargs – Keyword-arguments forwarded to campaign_well_plot().

save(path='', name=None)

Save the campaign to file.

This writes the campaign to a csv file.

Parameters

• path (str, optional) – Path where the variable should be saved. Default: ""

• name (str, optional) – Name of the file. If None, the name will be generated by "Cmp_"+name. Default: None

Notes

The file will get the suffix ".cmp".

property fieldsite

Field site where the campaign was realised.

Type

FieldSite

property tests

Tests within the campaign.

Type

dict

property wells

Wells within the campaign.

Type

dict