pytoughreact.plotting package

Submodules

pytoughreact.plotting.plot_multiple_files_routine module

MIT License

Copyright (c) [2022] [Temitope Ajayi]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

class pytoughreact.plotting.plot_multiple_files_routine.PlotMultiFiles(simulator_type, file_locations, file_titles, props, **kwargs)[source]

Bases: object

__init__(simulator_type, file_locations, file_titles, props, **kwargs)[source]

Class for processing multiple file results

Parameters:

  • file_locations (list[str]) – specifies the location of the files on the syste

  • file_titles (list[str]) – gives the title of the file e.g ‘kdd.conc’ or ‘OUTPUT.csv’.

  • simulator_type (str) – can either be toughreact, tmvoc or tough3

  • prop (list[str]) – properties to be plotted

  • **kwargs

  • value (x_slice) – value at which the plot should be sliced at the x axis

  • per_file (boolean) – if the plot should be made per file and not per property

  • tile (str) – title of each of the plots

multi_file_single_plot(grid_block_number, legend)[source]

Plot of Multiple Files with a single plot

Parameters:

  • grid_block_number (int) – The grid block number to be plotted

  • legend (list[str]) – List of legend values

plot_multi_element_multi_file(grid_block_number, legend, format_of_date, plot_kind='property')[source]

Plot of Multi Elements and Multiple Files

Parameters:

  • grid_block_number (int) – The grid block number to be plotted

  • legend (list[str]) – List of legend values

  • format_of_date (str) – The format of the date; could be minute, hour, day or year

  • plot_kind (str) – The kind of plot to be used; could be ‘property’ or ‘file’

plot_multi_file_distance(direction_x, direction_y, time, layer_num, legend)[source]

Plot of Parameter with Distance for Multiple Files

Parameters:

  • direction_x (str) – The direction to be plotted on the x axis

  • direction_y (str) – The direction to be plotted on the y axis

  • legend (list[str]) – List of legend values

  • layer_num (int) – The layer in the model to be plotted

  • time (int) – the time at which the plot is to be made

plot_multi_per_panel(grid_block_number, panels, format_of_date='day')[source]

Plot of Multi Properties Per Panel

Parameters:

  • grid_block_number (int) – The grid block number to be plotted

  • panels (int) – Number of panels

  • format_of_date (str) – The format of the date; could be minute, hour, day or year

pytoughreact.plotting.plot_multiple_tough_routine module

MIT License

Copyright (c) [2022] [Temitope Ajayi]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

class pytoughreact.plotting.plot_multiple_tough_routine.PlotMultiTough(simulatortype, filelocations, filetitles, **kwargs)[source]

Bases: object

__init__(simulatortype, filelocations, filetitles, **kwargs)[source]

Class for processing multiple file results

Parameters:

  • file_location (str) – specifies the location of the file on the system

  • file_title (str) – gives the title of the file e.g ‘kdd.conc’ or ‘OUTPUT.csv’.

  • simulator_type (str) – can either be toughreact, tmvoc or tough3

  • **kwargs

  • generation (str) – generation file location

  • restart_files (str) – restart file location

  • experiment (str) – experimental file location

get_restart_data_element(param, gridblocknumber)[source]
get_restart_data_time(format_of_date)[source]
get_restart_locations()[source]
multi_param_multi_file_plot(param, gridblocknumber, labels, format_of_date='year', style='horizontal', width=12, height=8)[source]

Line Plots of a multiple parameter in the results file as a function of time

Parameters:

  • param (list[str]) – The parameters to be plotted on the y-axis

  • grid_block_number (int) – the grid block in which its parameter evolution is to be observed.

  • format_of_date (str) – The format of the date; could be minute, hour, day or year

  • labels (list[str]) – Labels for the plots

  • style (str) – orientation for multiple plots; could be horizontal or vertical

  • width (int) – width of plot

  • height (int) – height of plot

multi_time_plot(param, gridblocknumber, format_of_date, style='horizontal')[source]

Line Plots of a multiple parameter in the results file as a function of time

Parameters:

  • param (list[str]) – The parameters to be plotted on the y-axis

  • grid_block_number (int) – the grid block in which its parameter evolution is to be observed.

  • format_of_date (str) – The format of the date; could be minute, hour, day or yeart

multi_time_plot_restart(param, gridblocknumber, format_of_date, style='horizontal')[source]

Line Plots of a multiple parameter in the results file as a function of time for restart files

Parameters:

  • param (list[str]) – The parameters to be plotted on the y-axis

  • grid_block_number (int) – the grid block in which its parameter evolution is to be observed.

  • format_of_date (str) – The format of the date; could be minute, hour, day or year

plot_multi_param_single_plot(param, gridblocknumber, format_of_date, labels=None)[source]

Line Multiple parameters in a single Plot

Parameters:

  • param (list[str]) – The parameters to be plotted on the y-axis

  • grid_block_number (int) – the grid block in which its parameter evolution is to be observed.

  • format_of_date (str) – The format of the date; could be minute, hour, day or year

  • labels (list[str]) – labels of the different plots in the chart

read_file()[source]
read_file_multi(file, filetitle)[source]

pytoughreact.plotting.plot_tough_routine module

MIT License

Copyright (c) [2022] [Temitope Ajayi]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

class pytoughreact.plotting.plot_tough_routine.PlotTough(simulator_type, file_location, file_title, **kwargs)[source]

Bases: object

__init__(simulator_type, file_location, file_title, **kwargs)[source]

Class for processing multiple file results

Parameters:

  • file_location (str) – specifies the location of the file on the system

  • file_title (str) – gives the title of the file e.g ‘kdd.conc’ or ‘OUTPUT.csv’.

  • simulator_type (str) – can either be toughreact, tmvoc or tough3

  • **kwargs

  • generation (str) – generation file location

  • restart_files (str) – restart file location

  • experiment (str) – experimental file location

plot_2d_one(direction_y_axis, direction_x_axis, param, timer)[source]

2D mesh plot (ungridded) to show the evolution of a particular parameter across a the entire domain at a particular time

Parameters:

  • direction_x_axis (str) – The direction to be plotted on the x axis

  • direction_y_axis (str) – The direction to be plotted on the y axis

  • param (str) – parameter to be plotted

  • time (int) – the time at which the plot is to be made

plot_2d_with_grid(direction_y_axis, direction_x_axis, param, timer)[source]

2D mesh plot (gridded) to show the evolution of a particular parameter across a the entire domain at a particular time

Parameters:

  • direction_x_axis (str) – The direction to be plotted on the x axis

  • direction_y_axis (str) – The direction to be plotted on the y axis

  • param (str) – parameter to be plotted

  • time (int) – the time at which the plot is to be made

plot_param_with_layer(direction_x_axis, direction_y_axis, param, layer_num, time)[source]

Line Plots to show the evolution of a particular parameter across a layer at a particular time

Parameters:

  • direction_x_axis (str) – The direction to be plotted on the x axis

  • direction_y_axis (str) – The direction to be plotted on the y axis

  • param (list[str]) – List of parameters

  • layer_num (int) – The layer in the model to be plotted

  • time (int) – the time at which the plot is to be made

plot_param_with_param(param1, param2, grid_block_number)[source]

Line Plot of two parameters in the results file

Parameters:

  • param1 (str) – The parameter to be plotted on the x-axis

  • param2 (str) – The parameter to be plotted on the y-axis

  • grid_block_number (int) – the grid block in which its parameter evolution is to be observed.

plot_param_with_time(param, grid_block_number, format_of_date)[source]

Line Plots of a parameter in the results file as a function of time

Parameters:

  • param (str) – The parameter to be plotted on the y-axis

  • grid_block_number (int) – the grid block in which its parameter evolution is to be observed.

  • format_of_date (str) – The format of the date; could be minute, hour, day or year

plot_param_with_time_restart(param, grid_block_number, format_of_date)[source]

Line Plots of a parameter in the results file as a function of time if restart was performed in the simulation

Parameters:

  • param (str) – The parameter to be plotted on the y-axis

  • grid_block_number (int) – the grid block in which its parameter evolution is to be observed.

  • format_of_date (str) – The format of the date; could be minute, hour, day or year

Module contents