Setter Reference: Climate, Rainfall, and Hydrology
Rendered from 12_all_set_functions.ipynb.
Climate and rainfall
climate
Kind: Model-level category
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.climate.areal_depletion_impervious(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate.areal_depletion_pervious(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate.evaporation_constant(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate.evaporation_dry_only(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.climate.evaporation_monthly(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate.evaporation_recovery_pattern(value) | ref | str | One model-level str value | Writable reference; target IDs are validated where possible |
m.set.climate.evaporation_time_series(value) | ref | str | One model-level str value | Writable reference; target IDs are validated where possible |
m.set.climate.evaporation_type(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.climate.snowmelt_parameters(value) | user | mixed | One model-level mixed value | Writable model-level value |
m.set.climate.temperature_time_series(value) | ref | str/table | One model-level str/table value | Writable reference; target IDs are validated where possible |
m.set.climate.wind_speed_monthly(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate.wind_speed_type(value) | user | enum | One model-level enum value | Writable model-level value |
Copy-ready call list:
m.set.climate.areal_depletion_impervious(value)
m.set.climate.areal_depletion_pervious(value)
m.set.climate.evaporation_constant(value)
m.set.climate.evaporation_dry_only(value)
m.set.climate.evaporation_monthly(value)
m.set.climate.evaporation_recovery_pattern(value)
m.set.climate.evaporation_time_series(value)
m.set.climate.evaporation_type(value)
m.set.climate.snowmelt_parameters(value)
m.set.climate.temperature_time_series(value)
m.set.climate.wind_speed_monthly(value)
m.set.climate.wind_speed_type(value)climate_adjustment
Kind: Model-level category
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.climate_adjustment.conductivity(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate_adjustment.evaporation(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate_adjustment.rainfall(value) | user | float | One model-level float value | Writable model-level value |
m.set.climate_adjustment.temperature(value) | user | float | One model-level float value | Writable model-level value |
Copy-ready call list:
m.set.climate_adjustment.conductivity(value)
m.set.climate_adjustment.evaporation(value)
m.set.climate_adjustment.rainfall(value)
m.set.climate_adjustment.temperature(value)rain_gage
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.rain_gage.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.rain_gage.filename(value, ids=None) | ref | path | path scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.rain_gage.format(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.rain_gage.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.rain_gage.interval(value, ids=None) | user | time | time scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.rain_gage.rainfall(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.rain_gage.snow_catch_factor(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.rain_gage.source_type(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.rain_gage.station(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.rain_gage.time_series(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.rain_gage.units(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.rain_gage.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.rain_gage.filename(value, ids=None)
m.set.rain_gage.format(value, ids=None)
m.set.rain_gage.id(value, ids=None)
m.set.rain_gage.interval(value, ids=None)
m.set.rain_gage.rainfall(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.rain_gage.snow_catch_factor(value, ids=None)
m.set.rain_gage.source_type(value, ids=None)
m.set.rain_gage.station(value, ids=None)
m.set.rain_gage.time_series(value, ids=None)
m.set.rain_gage.units(value, ids=None)Hydrology and catchments
subcatchment
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.subcatchment.area(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.centroid(value, ids=None) | user/derived | coordinates | One coordinate pair per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.subcatchment.curb_length(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.depression_storage_impervious(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.depression_storage_pervious(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.evaporation(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.groundwater_elevation(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.groundwater_flow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.impervious_percent(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.infiltration(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.n_impervious(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.n_pervious(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.outlet(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.subcatchment.percent_routed(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.pollutant_concentration(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.polygon(value, ids=None) | user | coordinates | One coordinate pair per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.rain_gage(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.subcatchment.rainfall(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.runoff(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.slope(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.snow_depth(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.snow_pack(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.subcatchment.soil_moisture(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.subcatchment.subarea_routing(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.tag(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.width(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.subcatchment.zero_depression_storage_impervious_percent(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.subcatchment.area(value, ids=None)
m.set.subcatchment.centroid(value, ids=None)
m.set.subcatchment.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.curb_length(value, ids=None)
m.set.subcatchment.depression_storage_impervious(value, ids=None)
m.set.subcatchment.depression_storage_pervious(value, ids=None)
m.set.subcatchment.evaporation(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.groundwater_elevation(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.groundwater_flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.id(value, ids=None)
m.set.subcatchment.impervious_percent(value, ids=None)
m.set.subcatchment.infiltration(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.n_impervious(value, ids=None)
m.set.subcatchment.n_pervious(value, ids=None)
m.set.subcatchment.outlet(value, ids=None)
m.set.subcatchment.percent_routed(value, ids=None)
m.set.subcatchment.pollutant_concentration(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.polygon(value, ids=None)
m.set.subcatchment.rain_gage(value, ids=None)
m.set.subcatchment.rainfall(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.runoff(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.slope(value, ids=None)
m.set.subcatchment.snow_depth(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.snow_pack(value, ids=None)
m.set.subcatchment.soil_moisture(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.subcatchment.subarea_routing(value, ids=None)
m.set.subcatchment.tag(value, ids=None)
m.set.subcatchment.width(value, ids=None)
m.set.subcatchment.zero_depression_storage_impervious_percent(value, ids=None)infiltration_horton
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.infiltration_horton.decay(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_horton.dry_time(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_horton.maximum_rate(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_horton.maximum_volume(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_horton.minimum_rate(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.infiltration_horton.decay(value, ids=None)
m.set.infiltration_horton.dry_time(value, ids=None)
m.set.infiltration_horton.maximum_rate(value, ids=None)
m.set.infiltration_horton.maximum_volume(value, ids=None)
m.set.infiltration_horton.minimum_rate(value, ids=None)infiltration_green_ampt
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.infiltration_green_ampt.hydraulic_conductivity(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_green_ampt.initial_moisture_deficit(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_green_ampt.suction_head(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.infiltration_green_ampt.hydraulic_conductivity(value, ids=None)
m.set.infiltration_green_ampt.initial_moisture_deficit(value, ids=None)
m.set.infiltration_green_ampt.suction_head(value, ids=None)infiltration_curve_number
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.infiltration_curve_number.conductivity(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_curve_number.curve_number(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.infiltration_curve_number.dry_time(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.infiltration_curve_number.conductivity(value, ids=None)
m.set.infiltration_curve_number.curve_number(value, ids=None)
m.set.infiltration_curve_number.dry_time(value, ids=None)aquifer
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.aquifer.bottom_elevation(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.conductivity(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.conductivity_slope(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.aquifer.field_capacity(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.lower_evaporation_depth(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.lower_groundwater_loss_rate(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.porosity(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.tension_slope(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.unsaturated_moisture(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.upper_evaporation_fraction(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.upper_evaporation_pattern(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.aquifer.water_table_elevation(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.aquifer.wilting_point(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.aquifer.bottom_elevation(value, ids=None)
m.set.aquifer.conductivity(value, ids=None)
m.set.aquifer.conductivity_slope(value, ids=None)
m.set.aquifer.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.aquifer.field_capacity(value, ids=None)
m.set.aquifer.id(value, ids=None)
m.set.aquifer.lower_evaporation_depth(value, ids=None)
m.set.aquifer.lower_groundwater_loss_rate(value, ids=None)
m.set.aquifer.porosity(value, ids=None)
m.set.aquifer.tension_slope(value, ids=None)
m.set.aquifer.unsaturated_moisture(value, ids=None)
m.set.aquifer.upper_evaporation_fraction(value, ids=None)
m.set.aquifer.upper_evaporation_pattern(value, ids=None)
m.set.aquifer.water_table_elevation(value, ids=None)
m.set.aquifer.wilting_point(value, ids=None)groundwater
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.groundwater.a1(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.a2(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.a3(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.aquifer(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.groundwater.b1(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.b2(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.deep_flow_equation(value, ids=None) | user | expression | One structured expression value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.fixed_depth(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.lateral_flow_equation(value, ids=None) | user | expression | One structured expression value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.node(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.groundwater.subcatchment(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.groundwater.surface_elevation(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.groundwater.threshold_elevation(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.groundwater.a1(value, ids=None)
m.set.groundwater.a2(value, ids=None)
m.set.groundwater.a3(value, ids=None)
m.set.groundwater.aquifer(value, ids=None)
m.set.groundwater.b1(value, ids=None)
m.set.groundwater.b2(value, ids=None)
m.set.groundwater.deep_flow_equation(value, ids=None)
m.set.groundwater.fixed_depth(value, ids=None)
m.set.groundwater.lateral_flow_equation(value, ids=None)
m.set.groundwater.node(value, ids=None)
m.set.groundwater.subcatchment(value, ids=None)
m.set.groundwater.surface_elevation(value, ids=None)
m.set.groundwater.threshold_elevation(value, ids=None)snow_pack
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.snow_pack.base_temperature(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.snow_pack.depth_at_100_percent_cover(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.destination_subcatchment(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.snow_pack.fraction_to_immediate_melt(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.fraction_to_impervious(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.fraction_to_outflow(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.fraction_to_pervious(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.fraction_to_subcatchment(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.free_water_capacity_fraction(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.impervious_fraction(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.initial_free_water(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.initial_snow_depth(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.maximum_melt_coefficient(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.minimum_melt_coefficient(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.pervious_fraction(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.plowable_fraction(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.snow_pack.removal_depth(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.snow_pack.base_temperature(value, ids=None)
m.set.snow_pack.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.snow_pack.depth_at_100_percent_cover(value, ids=None)
m.set.snow_pack.destination_subcatchment(value, ids=None)
m.set.snow_pack.fraction_to_immediate_melt(value, ids=None)
m.set.snow_pack.fraction_to_impervious(value, ids=None)
m.set.snow_pack.fraction_to_outflow(value, ids=None)
m.set.snow_pack.fraction_to_pervious(value, ids=None)
m.set.snow_pack.fraction_to_subcatchment(value, ids=None)
m.set.snow_pack.free_water_capacity_fraction(value, ids=None)
m.set.snow_pack.id(value, ids=None)
m.set.snow_pack.impervious_fraction(value, ids=None)
m.set.snow_pack.initial_free_water(value, ids=None)
m.set.snow_pack.initial_snow_depth(value, ids=None)
m.set.snow_pack.maximum_melt_coefficient(value, ids=None)
m.set.snow_pack.minimum_melt_coefficient(value, ids=None)
m.set.snow_pack.pervious_fraction(value, ids=None)
m.set.snow_pack.plowable_fraction(value, ids=None)
m.set.snow_pack.removal_depth(value, ids=None)unit_hydrograph
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.unit_hydrograph.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.unit_hydrograph.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.long_term_k(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.long_term_r(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.long_term_t(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.medium_term_k(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.medium_term_r(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.medium_term_t(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.month(value, ids=None) | user | enum/integer | One structured enum/integer value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.rain_gage(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.unit_hydrograph.short_term_k(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.short_term_r(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.unit_hydrograph.short_term_t(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.unit_hydrograph.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.unit_hydrograph.id(value, ids=None)
m.set.unit_hydrograph.long_term_k(value, ids=None)
m.set.unit_hydrograph.long_term_r(value, ids=None)
m.set.unit_hydrograph.long_term_t(value, ids=None)
m.set.unit_hydrograph.medium_term_k(value, ids=None)
m.set.unit_hydrograph.medium_term_r(value, ids=None)
m.set.unit_hydrograph.medium_term_t(value, ids=None)
m.set.unit_hydrograph.month(value, ids=None)
m.set.unit_hydrograph.rain_gage(value, ids=None)
m.set.unit_hydrograph.short_term_k(value, ids=None)
m.set.unit_hydrograph.short_term_r(value, ids=None)
m.set.unit_hydrograph.short_term_t(value, ids=None)lid_control
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.lid_control.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.lid_control.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_control.type(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.lid_control.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.lid_control.id(value, ids=None)
m.set.lid_control.type(value, ids=None)lid_surface
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.lid_surface.roughness(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_surface.side_slope(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_surface.slope(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_surface.storage_depth(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_surface.vegetation_fraction(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.lid_surface.roughness(value, ids=None)
m.set.lid_surface.side_slope(value, ids=None)
m.set.lid_surface.slope(value, ids=None)
m.set.lid_surface.storage_depth(value, ids=None)
m.set.lid_surface.vegetation_fraction(value, ids=None)lid_pavement
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.lid_pavement.clogging_factor(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_pavement.impervious_surface_fraction(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_pavement.permeability(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_pavement.thickness(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_pavement.void_ratio(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.lid_pavement.clogging_factor(value, ids=None)
m.set.lid_pavement.impervious_surface_fraction(value, ids=None)
m.set.lid_pavement.permeability(value, ids=None)
m.set.lid_pavement.thickness(value, ids=None)
m.set.lid_pavement.void_ratio(value, ids=None)lid_soil
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.lid_soil.conductivity(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_soil.conductivity_slope(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_soil.field_capacity(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_soil.porosity(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_soil.suction_head(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_soil.thickness(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_soil.wilting_point(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.lid_soil.conductivity(value, ids=None)
m.set.lid_soil.conductivity_slope(value, ids=None)
m.set.lid_soil.field_capacity(value, ids=None)
m.set.lid_soil.porosity(value, ids=None)
m.set.lid_soil.suction_head(value, ids=None)
m.set.lid_soil.thickness(value, ids=None)
m.set.lid_soil.wilting_point(value, ids=None)lid_storage
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.lid_storage.clogging_factor(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_storage.height(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_storage.seepage_rate(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_storage.void_ratio(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.lid_storage.clogging_factor(value, ids=None)
m.set.lid_storage.height(value, ids=None)
m.set.lid_storage.seepage_rate(value, ids=None)
m.set.lid_storage.void_ratio(value, ids=None)lid_drain
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.lid_drain.closed_level(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_drain.coefficient(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_drain.control_curve(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.lid_drain.delay(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_drain.exponent(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_drain.offset_height(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_drain.open_level(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.lid_drain.closed_level(value, ids=None)
m.set.lid_drain.coefficient(value, ids=None)
m.set.lid_drain.control_curve(value, ids=None)
m.set.lid_drain.delay(value, ids=None)
m.set.lid_drain.exponent(value, ids=None)
m.set.lid_drain.offset_height(value, ids=None)
m.set.lid_drain.open_level(value, ids=None)lid_usage
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.lid_usage.area(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_usage.drain_outflow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.lid_usage.drain_to(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.lid_usage.evaporation(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.lid_usage.from_impervious_percent(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_usage.from_pervious_percent(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_usage.infiltration(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.lid_usage.inflow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.lid_usage.initial_saturation(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_usage.lid_control(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.lid_usage.number(value, ids=None) | user | integer | One structured integer value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.lid_usage.outlet(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.lid_usage.storage(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.lid_usage.subcatchment(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.lid_usage.surface_outflow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.lid_usage.width(value, ids=None) | user | float | One structured float value per selected ID | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.lid_usage.area(value, ids=None)
m.set.lid_usage.drain_outflow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.lid_usage.drain_to(value, ids=None)
m.set.lid_usage.evaporation(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.lid_usage.from_impervious_percent(value, ids=None)
m.set.lid_usage.from_pervious_percent(value, ids=None)
m.set.lid_usage.infiltration(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.lid_usage.inflow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.lid_usage.initial_saturation(value, ids=None)
m.set.lid_usage.lid_control(value, ids=None)
m.set.lid_usage.number(value, ids=None)
m.set.lid_usage.outlet(value, ids=None)
m.set.lid_usage.storage(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.lid_usage.subcatchment(value, ids=None)
m.set.lid_usage.surface_outflow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.lid_usage.width(value, ids=None)