welltestpy.data.Campaign
- class Campaign(name, fieldsite='Fieldsite', wells=None, tests=None, timeframe=None, description='Welltest campaign')[source]
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
orVariable
, 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 ofWell
. Default:None
wells (
dict
, optional) – The tests within the campaign. Keys are the test names and values are an instance ofTest
. Default:None
timeframe (
str
, optional) – Timeframe of the campaign. Default:None
description (
str
, optional) – Description of the field site. Default:"Welltest campaign"
- Attributes
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)[source]
Add a single well to the campaign.
- addtests(tests)[source]
Add some specified tests.
This will add tests to the campaign.
- Parameters
tests (
dict
) – Tests to be added.
- addwells(wells)[source]
Add some specified wells.
This will add wells to the campaign.
- Parameters
wells (
dict
) – Wells to be added.
- deltests(tests)[source]
Delete some specified tests.
This will delete tests from the campaign. You can give a list of tests or a single test by name.
- delwells(wells)[source]
Delete some specified wells.
This will delete wells from the campaign. You can give a list of wells or a single well by name.
- diagnostic_plot(pumping_test, observation_well, **kwargs)[source]
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)[source]
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)[source]
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()
.