welltestpy.data.campaignlib

Welltestpy subpackage providing flow datastructures for field-campaigns.

The following classes and functions are provided

FieldSite(name[, description, coordinates])	Class for a field site.
Campaign(name[, fieldsite, wells, tests, …])	Class for a well based campaign.

class FieldSite(name, description='Field site', coordinates=None)

Bases: object

Class for a field site.

This is a class for a field site. It has a name and a descrition.

Parameters:

• name (str) – Name of the field site.
• description (str, optional) – Description of the field site. Default: "no description"
• coordinates (Variable, optional) – Coordinates of the field site (lat, lon). Default: None

Attributes:

coordinates

numpy.ndarray: Coordinates of the field site.

info

str: Info about the field site.

pos

numpy.ndarray: Position of the field site.

Methods

save([path, name])

Save a field site to file.

save(path='', name=None)

Save a field site to file.

This writes the field site 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 "Field_"+name. Default: None

Notes

The file will get the suffix ".fds".

coordinates

Coordinates of the field site.

Type:numpy.ndarray

info

Info about the field site.

Type:str

pos

Position of the field site.

Type:numpy.ndarray

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 descrition 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 fild site. Keys are the well names and values are an instance of Well. Default: None
• wells – 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.
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.

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".

fieldsite

Field site where the campaign was realised.

Type:FieldSite

tests

Tests within the campaign.

Type:dict

wells

Wells within the campaign.

Type:dict