CompartmentalSystems.bins package

Submodules

CompartmentalSystems.bins.CompatibleTsTpMassFieldsPerPool module

class CompartmentalSystems.bins.CompatibleTsTpMassFieldsPerPool.CompatibleTsTpMassFieldsPerPool(normal_list)

Bases: CompartmentalSystems.bins.TsTpMassFields.TsTpMassFieldsPerPool

advanced(external_inputs, internal_death_rate_fields, outward_death_rate_fields)

property number_of_pools

CompartmentalSystems.bins.FieldsPerTimeStep module

class CompartmentalSystems.bins.FieldsPerTimeStep.FieldsPerTimeStep(listOfTimeFields, start)

Bases: list

property t_max

property t_min

property times

property tss

CompartmentalSystems.bins.TimeBin module

class CompartmentalSystems.bins.TimeBin.TimeBin(tss, smin, pmin, content, facecolors=None, offset=0)

Bases: object

plot(ax)

verts()

CompartmentalSystems.bins.TimeField module

class CompartmentalSystems.bins.TimeField.TimeField(arr, tss)

Bases: object

property max_Ts

property number_of_Ts_entries

property shape

CompartmentalSystems.bins.TimeMassField module

class CompartmentalSystems.bins.TimeMassField.TimeMassField(arr, tss)

Bases: CompartmentalSystems.bins.TimeField.TimeField

CompartmentalSystems.bins.TimeStep module

class CompartmentalSystems.bins.TimeStep.TimeStep(time, rectangles, internal_death_rate_fields, external_death_rate_fields, external_input_numbers)

Bases: object

property updated_content

CompartmentalSystems.bins.TimeStepIterator module

class CompartmentalSystems.bins.TimeStepIterator.TimeStepIterator(initial_plains, external_input_funcs, internal_death_rate_funcs, external_death_rate_funcs, t0, number_of_steps)

Bases: object

iterator for looping over the results of a difference equation

classmethod from_ode_reservoir_model_run(mr, initial_plains=None)

reset()

property tss

CompartmentalSystems.bins.TimeStepIterator.external_death_rate_maker(sender, func, solfs)

CompartmentalSystems.bins.TimeStepIterator.external_input_maker(tss, receiver, func)

CompartmentalSystems.bins.TimeStepIterator.internal_death_rate_maker(key, func, solfs)

CompartmentalSystems.bins.TimeStepPlotter module

class CompartmentalSystems.bins.TimeStepPlotter.TimeStepPlotter(time_step)

Bases: object

plot_pdfs()

CompartmentalSystems.bins.TimeStepPlotter.plot_contents_and_gains(contents, internal_gains, external_gains, max_Ts, max_Tp, max_z)

CompartmentalSystems.bins.TimeStepPlotter.plot_contents_and_losses(remainders, internal_losses, external_losses, max_Ts, max_Tp, max_z)

CompartmentalSystems.bins.TimeStepPlotter.plot_external_gains(external_input_numbers, tss, nTs, nTp, max_z)

CompartmentalSystems.bins.TimeStepPlotter.plot_figure_per_pipe(rectangles, max_Ts, max_Tp, max_z, title_stem, facecolors)

CompartmentalSystems.bins.TimeStepPlotter.plot_figure_per_pool(rectangles, max_Ts, max_Tp, max_z, title_stem, facecolors)

CompartmentalSystems.bins.TimeStepPlotter.plot_internal_gains(gains, max_Ts, max_Tp, max_z)

CompartmentalSystems.bins.TsMassField module

class CompartmentalSystems.bins.TsMassField.TsMassField(arr, tss)

Bases: CompartmentalSystems.bins.TimeMassField.TimeMassField

default_plot_args(time, Ts_max=None, t_min=None, t_max=None, z_max=None)

plot_bins(ax, time, Ts_max=None, t_min=None, t_max=None, z_max=None, facecolors=None, offset_field=None)

shifted()

CompartmentalSystems.bins.TsMassFieldsPerTimeStep module

class CompartmentalSystems.bins.TsMassFieldsPerTimeStep.TsMassFieldsPerTimeStep(listOfTimeFields, start)

Bases: CompartmentalSystems.bins.FieldsPerTimeStep.FieldsPerTimeStep

property max_Ts

property max_number_of_Ts_entries

plot_bins(ax, mr=None, pool=None)

plot_surface(ax, mr=None, pool=None)

CompartmentalSystems.bins.TsTpBin module

class CompartmentalSystems.bins.TsTpBin.TsTpBin(tss, smin, pmin, content, facecolors=None, offset=0)

Bases: CompartmentalSystems.bins.TimeBin.TimeBin

plot(ax)

CompartmentalSystems.bins.TsTpDeathRateField module

class CompartmentalSystems.bins.TsTpDeathRateField.TsTpDeathRateField(arr, tss)

Bases: CompartmentalSystems.bins.TsTpField.TsTpField

CompartmentalSystems.bins.TsTpField module

class CompartmentalSystems.bins.TsTpField.TsTpField(arr, tss)

Bases: CompartmentalSystems.bins.TimeField.TimeField

default_plot_args(max_shape=None, z_max=None)

property max_Tp

property number_of_Tp_entries

plot_bins(ax, max_shape=None, z_max=None, facecolors=None, offset_field=None)

plot_surface(ax, max_shape=None, z_max=None)

set_limits(ax, max_shape, z_max)

set_ticks_and_labels(max_shape, ax)

CompartmentalSystems.bins.TsTpMassField module

class CompartmentalSystems.bins.TsTpMassField.TsTpMassField(arr, tss)

Bases: CompartmentalSystems.bins.TimeMassField.TimeMassField, CompartmentalSystems.bins.TsTpField.TsTpField

loss(eta_dist)

receive(age_shifted_gain)

receive_external(brand_new_stuff)

remove_loss(loss)

resize(max_index)

shift()

sum_over_all_pool_ages()

property total_content

CompartmentalSystems.bins.TsTpMassFields module

class CompartmentalSystems.bins.TsTpMassFields.TimeMassFields

Bases: dict

shift()

class CompartmentalSystems.bins.TsTpMassFields.TsMassFieldsPerPool(*args, **kwargs)

Bases: CompartmentalSystems.bins.TsTpMassFields.TimeMassFields

class CompartmentalSystems.bins.TsTpMassFields.TsTpMassFieldsPerPipe(*args, **kwargs)

Bases: CompartmentalSystems.bins.TsTpMassFields.TimeMassFields

property gains

class CompartmentalSystems.bins.TsTpMassFields.TsTpMassFieldsPerPool(*args, **kwargs)

Bases: CompartmentalSystems.bins.TsTpMassFields.TimeMassFields

external_losses(external_death_rate_fields)

internal_losses(internal_death_rate_fields)

receive(gains)

receive_external(external_inputs)

remove(l)

shift()

CompartmentalSystems.bins.TsTpMassFieldsPerPoolPerTimeStep module

class CompartmentalSystems.bins.TsTpMassFieldsPerPoolPerTimeStep.TsTpMassFieldsPerPoolPerTimeStep(multi_pool_pyramid, start)

Bases: object

classmethod from_time_step_iterator(iterator)

matrix_plot(sub_func_name, fig)

matrix_plot3d(sub_func_name, fig, title=None, mr=None)

property number_of_pools

singlePoolPyramid(pool_nr)

single_pool_cartoon(pool_number, trunk)

property tss

CompartmentalSystems.bins.TsTpMassFieldsPerTimeStep module

class CompartmentalSystems.bins.TsTpMassFieldsPerTimeStep.TsTpMassFieldsPerTimeStep(listOfTimeFields, start)

Bases: CompartmentalSystems.bins.FieldsPerTimeStep.FieldsPerTimeStep

plot_system_age_distributions_as_surfaces(ax, mr=None, pool=None)

plot_system_age_distributions_with_bins(ax, mr=None, pool=None)

plot_total_contents(ax)

system_age_distributions()

property total_contents

CompartmentalSystems.bins.TstBin module

class CompartmentalSystems.bins.TstBin.TstBin(tss, smin, pmin, content, facecolors=None, offset=0)

Bases: CompartmentalSystems.bins.TimeBin.TimeBin

plot(ax)

CompartmentalSystems.bins.density_algorithm module

CompartmentalSystems.bins.density_algorithm.gains(pool_number, internal_losses)

CompartmentalSystems.bins.density_algorithm.losses(old_rectangles, death_rates, time)

CompartmentalSystems.bins.getsizeof module

CompartmentalSystems.bins.getsizeof.total_size(o, handlers={}, verbose=False)

Returns the approximate memory footprint of an object and all of its contents.

Automatically finds the contents of the following builtin containers and their subclasses: tuple, list, deque, dict, set and frozenset. To search other containers, add handlers to iterate over their contents:

handlers = {SomeContainerClass: iter,

OtherContainerClass: OtherContainerClass.get_elements}

CompartmentalSystems.bins.gv module

CompartmentalSystems.bins.gv.default_data_type()

CompartmentalSystems.bins.gv.indexed_color(index)

CompartmentalSystems.bins.gv.indexed_filled_marker(index)

CompartmentalSystems.bins.gv.rotated_access(_list, index)

CompartmentalSystems.bins.plot_helpers module

class CompartmentalSystems.bins.plot_helpers.SinglePlotFigureHandler(figure_filename)

Bases: object

CompartmentalSystems.bins.plot_helpers.add_xhist_data_to_scatter(plot_ax, data, label, fontsize, show_grid=True)

CompartmentalSystems.bins.plot_helpers.cc(arg, alpha=None)

Module contents