Optimization
TimeSeries
ProjectFramework
PlotData
ParameterScenario
ParameterSet
API Reference
calibrate()
cascade_summary()
get_cascade_data()
get_cascade_vals()
plot_cascade()
plot_multi_cascade()
plot_single_cascade()
plot_single_cascade_series()
sanitize_cascade()
sanitize_pops()
validate_cascade()
CascadeEnsemble
CascadeEnsemble.add()
CascadeEnsemble.baseline
CascadeEnsemble.boxplot()
CascadeEnsemble.get_vals()
CascadeEnsemble.mapping_function
CascadeEnsemble.n_samples
CascadeEnsemble.outputs
CascadeEnsemble.plot_bars()
CascadeEnsemble.plot_distribution()
CascadeEnsemble.plot_multi_cascade()
CascadeEnsemble.plot_series()
CascadeEnsemble.pops
CascadeEnsemble.results
CascadeEnsemble.run_sims()
CascadeEnsemble.samples
CascadeEnsemble.set_baseline()
CascadeEnsemble.tvec
CascadeEnsemble.update()
InvalidCascade
ProjectData
ProjectData.add_interaction()
ProjectData.add_pop()
ProjectData.add_transfer()
ProjectData.change_tvec()
ProjectData.end_year
ProjectData.from_spreadsheet()
ProjectData.get_tdve_page()
ProjectData.get_ts()
ProjectData.interpops
ProjectData.new()
ProjectData.pops
ProjectData.remove_interaction()
ProjectData.remove_transfer()
ProjectData.rename_pop()
ProjectData.rename_transfer()
ProjectData.save()
ProjectData.start_year
ProjectData.tables()
ProjectData.tdve
ProjectData.tdve_pages
ProjectData.to_spreadsheet()
ProjectData.to_workbook()
ProjectData.transfers
ProjectData.tvec
ProjectData.validate()
InvalidDatabook
demo()
make_demo_scenarios()
apply_widths()
cell_get_number()
cell_get_string()
copy_sheet()
read_dataframes()
read_tables()
standard_formats()
transfer_comments()
update_widths()
validate_category()
TimeDependentConnections
TimeDependentConnections.assumption_heading
TimeDependentConnections.attributes
TimeDependentConnections.from_tables()
TimeDependentConnections.ts_attributes
TimeDependentConnections.write()
TimeDependentConnections.write_assumption
TimeDependentConnections.write_uncertainty
TimeDependentConnections.write_units
TimeDependentValuesEntry
TimeDependentValuesEntry.assumption_heading
TimeDependentValuesEntry.comment
TimeDependentValuesEntry.from_rows()
TimeDependentValuesEntry.has_data
TimeDependentValuesEntry.name
TimeDependentValuesEntry.ts_attributes
TimeDependentValuesEntry.tvec
TimeDependentValuesEntry.write()
TimeDependentValuesEntry.write_assumption
TimeDependentValuesEntry.write_uncertainty
TimeDependentValuesEntry.write_units
generate_framework_doc()
ProjectFramework.cascades
ProjectFramework.characs
ProjectFramework.comps
ProjectFramework.created
ProjectFramework.get_charac()
ProjectFramework.get_charac_includes()
ProjectFramework.get_comp()
ProjectFramework.get_databook_units()
ProjectFramework.get_interaction()
ProjectFramework.get_label()
ProjectFramework.get_par()
ProjectFramework.get_variable()
ProjectFramework.gitinfo
ProjectFramework.interactions
ProjectFramework.modified
ProjectFramework.name
ProjectFramework.pars
ProjectFramework.pop_types
ProjectFramework.save()
ProjectFramework.sheets
ProjectFramework.spreadsheet
ProjectFramework.to_spreadsheet()
ProjectFramework.uid
ProjectFramework.version
InvalidFramework
parse_function()
sdiv()
vector_max()
vector_min()
all_frameworks()
all_progsets()
all_results()
migrate()
migration()
register_migration()
Migration
run_model()
Characteristic
Characteristic.id
Characteristic.name
Characteristic.plot()
Characteristic.pop
Characteristic.preallocate()
Characteristic.set_dynamic()
Characteristic.units
Characteristic.update()
Compartment
Compartment.connect()
Compartment.id
Compartment.name
Compartment.outflow
Compartment.plot()
Compartment.pop
Compartment.preallocate()
Compartment.resolve_outflows()
Compartment.set_dynamic()
Compartment.units
Compartment.update()
JunctionCompartment
JunctionCompartment.balance()
JunctionCompartment.connect()
JunctionCompartment.duration_group
JunctionCompartment.id
JunctionCompartment.initial_flush()
JunctionCompartment.name
JunctionCompartment.outflow
JunctionCompartment.plot()
JunctionCompartment.pop
JunctionCompartment.preallocate()
JunctionCompartment.resolve_outflows()
JunctionCompartment.set_dynamic()
JunctionCompartment.units
JunctionCompartment.update()
Link
Link.create()
Link.id
Link.name
Link.plot()
Link.pop
Link.preallocate()
Link.set_dynamic()
Link.units
Link.update()
Model
Model.build()
Model.dt
Model.flush_junctions()
Model.get_pop()
Model.process()
Model.relink()
Model.t
Model.unlink()
Model.update_comps()
Model.update_links()
Model.update_pars()
Parameter
Parameter.constrain()
Parameter.deps
Parameter.derivative
Parameter.fcn_str
Parameter.id
Parameter.limits
Parameter.links
Parameter.name
Parameter.plot()
Parameter.pop
Parameter.pop_aggregation
Parameter.preallocate()
Parameter.scale_factor
Parameter.set_dynamic()
Parameter.set_fcn()
Parameter.skip_function
Parameter.timescale
Parameter.units
Parameter.update()
Population
Population.build()
Population.charac_lookup
Population.characs
Population.comp_lookup
Population.comps
Population.get_charac()
Population.get_comp()
Population.get_links()
Population.get_par()
Population.get_variable()
Population.initialize_compartments()
Population.label
Population.link_lookup
Population.links
Population.name
Population.par_lookup
Population.pars
Population.popsize()
Population.type
ResidualJunctionCompartment
ResidualJunctionCompartment.balance()
ResidualJunctionCompartment.connect()
ResidualJunctionCompartment.duration_group
ResidualJunctionCompartment.id
ResidualJunctionCompartment.initial_flush()
ResidualJunctionCompartment.name
ResidualJunctionCompartment.outflow
ResidualJunctionCompartment.plot()
ResidualJunctionCompartment.pop
ResidualJunctionCompartment.preallocate()
ResidualJunctionCompartment.resolve_outflows()
ResidualJunctionCompartment.set_dynamic()
ResidualJunctionCompartment.units
ResidualJunctionCompartment.update()
SinkCompartment
SinkCompartment.connect()
SinkCompartment.id
SinkCompartment.name
SinkCompartment.outflow
SinkCompartment.plot()
SinkCompartment.pop
SinkCompartment.preallocate()
SinkCompartment.resolve_outflows()
SinkCompartment.set_dynamic()
SinkCompartment.units
SinkCompartment.update()
SourceCompartment
SourceCompartment.connect()
SourceCompartment.id
SourceCompartment.name
SourceCompartment.outflow
SourceCompartment.plot()
SourceCompartment.pop
SourceCompartment.preallocate()
SourceCompartment.resolve_outflows()
SourceCompartment.set_dynamic()
SourceCompartment.units
SourceCompartment.update()
TimedCompartment
TimedCompartment.connect()
TimedCompartment.flush_link
TimedCompartment.id
TimedCompartment.name
TimedCompartment.outflow
TimedCompartment.parameter
TimedCompartment.plot()
TimedCompartment.pop
TimedCompartment.preallocate()
TimedCompartment.resolve_outflows()
TimedCompartment.set_dynamic()
TimedCompartment.units
TimedCompartment.update()
TimedCompartment.vals
TimedLink
TimedLink.create()
TimedLink.id
TimedLink.name
TimedLink.plot()
TimedLink.pop
TimedLink.preallocate()
TimedLink.set_dynamic()
TimedLink.units
TimedLink.update()
TimedLink.vals
Variable
Variable.id
Variable.name
Variable.plot()
Variable.pop
Variable.preallocate()
Variable.set_dynamic()
Variable.units
Variable.update()
BadInitialization
ModelError
constrain_sum_bounded()
optimize()
Adjustable
Adjustable.get_hard_bounds()
Adjustment
Adjustment.adjustables
Adjustment.get_initialization()
AtLeastMeasurable
AtLeastMeasurable.get_baseline()
AtLeastMeasurable.get_objective_val()
AtMostMeasurable
AtMostMeasurable.get_baseline()
AtMostMeasurable.get_objective_val()
Constraint
Constraint.constrain_instructions()
Constraint.get_hard_constraint()
DecreaseByMeasurable
DecreaseByMeasurable.get_baseline()
DecreaseByMeasurable.get_objective_val()
ExponentialSpendingAdjustment
ExponentialSpendingAdjustment.adjustables
ExponentialSpendingAdjustment.get_initialization()
IncreaseByMeasurable
IncreaseByMeasurable.get_baseline()
IncreaseByMeasurable.get_objective_val()
MaximizeCascadeConversionRate
MaximizeCascadeConversionRate.get_baseline()
MaximizeCascadeConversionRate.get_objective_val()
MaximizeCascadeStage
MaximizeCascadeStage.get_baseline()
MaximizeCascadeStage.get_objective_val()
MaximizeMeasurable
MaximizeMeasurable.get_baseline()
MaximizeMeasurable.get_objective_val()
Measurable
Measurable.get_baseline()
Measurable.get_objective_val()
MinimizeMeasurable
MinimizeMeasurable.get_baseline()
MinimizeMeasurable.get_objective_val()
Optimization.compute_objective()
Optimization.constrain_instructions()
Optimization.get_adjustment()
Optimization.get_baselines()
Optimization.get_hard_constraints()
Optimization.get_initialization()
Optimization.maxiters
Optimization.maxtime
Optimization.method
Optimization.update_instructions()
PairedLinearSpendingAdjustment
PairedLinearSpendingAdjustment.adjustables
PairedLinearSpendingAdjustment.get_initialization()
SpendingAdjustment
SpendingAdjustment.adjustables
SpendingAdjustment.get_initialization()
SpendingPackageAdjustment
SpendingPackageAdjustment.adjust_total_spend
SpendingPackageAdjustment.adjustables
SpendingPackageAdjustment.get_initialization()
StartTimeAdjustment
StartTimeAdjustment.adjustables
StartTimeAdjustment.get_initialization()
TotalSpendConstraint
TotalSpendConstraint.constrain_instructions()
TotalSpendConstraint.get_hard_constraint()
FailedConstraint
InvalidInitialConditions
UnresolvableConstraint
Parameter.has_values()
Parameter.interpolate()
Parameter.pops
Parameter.sample()
Parameter.smooth()
ParameterSet.all_pars()
ParameterSet.calibration_spreadsheet()
ParameterSet.get_par()
ParameterSet.load_calibration()
ParameterSet.sample()
ParameterSet.save_calibration()
ParameterSet.y_factors
plot_bars()
plot_legend()
plot_series()
relabel_legend()
reorder_legend()
save_figs()
PlotData.__getitem__()
PlotData.accumulate()
PlotData.interpolate()
PlotData.programs()
PlotData.set_colors()
PlotData.time_aggregate()
PlotData.tvals()
Series
Series.data_label
Series.data_pop
Series.interpolate()
Series.timescale
Series.unit_string
Series.units
Covout
Covout.compute_impact_interaction()
Covout.get_outcome()
Covout.n_progs
Covout.sample()
Covout.update_outcomes()
Program
Program.baseline_spend
Program.capacity_constraint
Program.coverage
Program.get_capacity()
Program.get_prop_covered()
Program.get_spend()
Program.is_one_off
Program.label
Program.name
Program.sample()
Program.saturation
Program.spend_data
Program.target_comps
Program.target_pops
Program.unit_cost
ProgramInstructions
ProgramInstructions.scale_alloc()
ProgramSet
ProgramSet.add_comp()
ProgramSet.add_par()
ProgramSet.add_pop()
ProgramSet.add_program()
ProgramSet.from_spreadsheet()
ProgramSet.get_alloc()
ProgramSet.get_capacities()
ProgramSet.get_outcomes()
ProgramSet.get_prop_coverage()
ProgramSet.new()
ProgramSet.remove_comp()
ProgramSet.remove_par()
ProgramSet.remove_pop()
ProgramSet.remove_program()
ProgramSet.sample()
ProgramSet.to_spreadsheet()
ProgramSet.to_workbook()
ProgramSet.validate()
InvalidProgramBook
Project
Project.calibrate()
Project.create_databook()
Project.load()
Project.load_databook()
Project.load_progbook()
Project.make_parset()
Project.make_progbook()
Project.make_scenario()
Project.optim()
Project.parset()
Project.parsets
Project.progset()
Project.result()
Project.run_optimization()
Project.run_sampled_sims()
Project.run_scenarios()
Project.run_sim()
Project.save()
Project.scen()
Project.update_settings()
ProjectSettings
ProjectSettings.tvec
ProjectSettings.update_time_vector()
reconcile()
export_results()
Ensemble
Ensemble.add()
Ensemble.baseline
Ensemble.boxplot()
Ensemble.mapping_function
Ensemble.n_samples
Ensemble.outputs
Ensemble.plot_bars()
Ensemble.plot_distribution()
Ensemble.plot_series()
Ensemble.pops
Ensemble.results
Ensemble.run_sims()
Ensemble.samples
Ensemble.set_baseline()
Ensemble.tvec
Ensemble.update()
Result
Result.charac_names()
Result.check_for_nans()
Result.comp_names()
Result.dt
Result.export_raw()
Result.framework
Result.get_alloc()
Result.get_coverage()
Result.get_equivalent_alloc()
Result.get_variable()
Result.link_names()
Result.par_names()
Result.plot()
Result.pop_labels
Result.t
Result.used_programs
BudgetScenario
BudgetScenario.active
BudgetScenario.get_instructions()
BudgetScenario.get_parset()
BudgetScenario.get_progset()
BudgetScenario.parsetname
BudgetScenario.progsetname
BudgetScenario.run()
CombinedScenario
CombinedScenario.active
CombinedScenario.get_instructions()
CombinedScenario.get_parset()
CombinedScenario.get_progset()
CombinedScenario.interpolation
CombinedScenario.parsetname
CombinedScenario.progsetname
CombinedScenario.run()
CombinedScenario.scenario_values
CoverageScenario
CoverageScenario.active
CoverageScenario.get_instructions()
CoverageScenario.get_parset()
CoverageScenario.get_progset()
CoverageScenario.parsetname
CoverageScenario.progsetname
CoverageScenario.run()
ParameterScenario.active
ParameterScenario.add()
ParameterScenario.get_instructions()
ParameterScenario.get_parset()
ParameterScenario.get_progset()
ParameterScenario.interpolation
ParameterScenario.parsetname
ParameterScenario.progsetname
ParameterScenario.run()
ParameterScenario.scenario_values
Scenario
Scenario.active
Scenario.get_instructions()
Scenario.get_parset()
Scenario.get_progset()
Scenario.parsetname
Scenario.progsetname
Scenario.run()
atomica_path()
FrameworkSettings
NotFoundError
datetime_to_year()
evaluate_plot_string()
format_duration()
nested_loop()
parallel_progress()
parent_dir()
start_logging()
stop_logging()
NDict
NDict.__add__()
NDict.append()
NDict.clear()
NDict.copy()
NDict.dict_items()
NDict.dict_keys()
NDict.dict_values()
NDict.disp()
NDict.enumitems()
NDict.enumkeys()
NDict.enumvals()
NDict.enumvalues()
NDict.export()
NDict.filter()
NDict.filtervals()
NDict.findbykey()
NDict.findbyval()
NDict.findkeys()
NDict.fromeach()
NDict.fromkeys()
NDict.get()
NDict.getnested()
NDict.index()
NDict.insert()
NDict.items()
NDict.iteritems()
NDict.iternested()
NDict.keys()
NDict.make()
NDict.makefrom()
NDict.makenested()
NDict.map()
NDict.pop()
NDict.popitem()
NDict.promote()
NDict.remove()
NDict.rename()
NDict.reverse()
NDict.reversed()
NDict.setdefault()
NDict.setitem()
NDict.setnested()
NDict.sort()
NDict.sorted()
NDict.toeach()
NDict.update()
NDict.valind()
NDict.values()
NamedItem
Quiet
TimeSeries.assumption
TimeSeries.copy()
TimeSeries.get()
TimeSeries.get_arrays()
TimeSeries.has_data
TimeSeries.has_time_data
TimeSeries.insert()
TimeSeries.interpolate()
TimeSeries.remove()
TimeSeries.remove_after()
TimeSeries.remove_before()
TimeSeries.remove_between()
TimeSeries.sample()
TimeSeries.sigma
TimeSeries.t
TimeSeries.units
TimeSeries.vals
Exception type for general model errors
This error gets raised for generic errors arising during integration