Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add waterquality (substance/concentration) tables #1267

Merged
merged 8 commits into from
May 6, 2024
Merged

Add waterquality (substance/concentration) tables #1267

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bfa1a19
Add waterquality tables.
evetion Mar 14, 2024
2a8de52
Fix generation & mypy.
evetion Mar 14, 2024
547bb54
Merge main.
evetion May 6, 2024
68363df
Regenerate schemas.
evetion May 6, 2024
40807de
Fix casing.
evetion May 6, 2024
12a665a
Merge basin concentration tables.
evetion May 6, 2024
d1651b2
Split out tables once more.
evetion May 6, 2024
9d78c3f
Forgot to remove basin from concentration table.
evetion May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix generation & mypy.
  • Loading branch information
@evetion
evetion committed Mar 14, 2024
commit 2a8de52d8b41d99980c73044315f2f3c1c988313
34 changes: 34 additions & 0 deletions core/src/schema.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@
@schema "ribasim.basin.profile" BasinProfile
@schema "ribasim.basin.state" BasinState
@schema "ribasim.basin.subgrid" BasinSubgrid
@schema "ribasim.basin.boundaryconcentration" BasinBoundaryconcentration
@schema "ribasim.basin.concentration" BasinConcentration
@schema "ribasim.terminal.static" TerminalStatic
@schema "ribasim.fractionalflow.static" FractionalFlowStatic
@schema "ribasim.flowboundary.static" FlowBoundaryStatic
@schema "ribasim.flowboundary.time" FlowBoundaryTime
@schema "ribasim.flowboundary.concentration" FlowBoundaryConcentration
@schema "ribasim.levelboundary.static" LevelBoundaryStatic
@schema "ribasim.levelboundary.time" LevelBoundaryTime
@schema "ribasim.levelboundary.concentration" LevelBoundaryConcentration
@schema "ribasim.linearresistance.static" LinearResistanceStatic
@schema "ribasim.manningresistance.static" ManningResistanceStatic
@schema "ribasim.pidcontrol.static" PidControlStatic
Expand Down Expand Up @@ -96,6 +100,22 @@ end
urban_runoff::Union{Missing, Float64}
end

@version BasinBoundaryconcentrationV1 begin
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BasinBoundaryConcentration

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, that breaks some generation in the Julia code.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

@version BasinConcentrationV1 begin
    node_id::Int32
    time::DateTime
    substance::String
    basin::Union{Missing, Float64}  # optional, for external calculations
    drainage::Union{Missing, Float64}
    precipitation::Union{Missing, Float64}
end

node_id::Int32
time::DateTime
substance::String
drainage_concentration::Union{Missing, Float64}
precipitation_concentration::Union{Missing, Float64}
urban_runoff_concentration::Union{Missing, Float64}
end

@version BasinConcentrationV1 begin
node_id::Int32
time::DateTime
substance::String
concentration::Float64
end

@version BasinProfileV1 begin
node_id::Int32
area::Float64
Expand Down Expand Up @@ -132,6 +152,13 @@ end
level::Float64
end

@version LevelBoundaryConcentrationV1 begin
node_id::Int32
time::DateTime
substance::String
concentration::Float64
end

@version FlowBoundaryStaticV1 begin
node_id::Int32
active::Union{Missing, Bool}
Expand All @@ -144,6 +171,13 @@ end
flow_rate::Float64
end

@version FlowBoundaryConcentrationV1 begin
node_id::Int32
time::DateTime
substance::String
concentration::Float64
end

@version LinearResistanceStaticV1 begin
node_id::Int32
active::Union{Missing, Bool}
Expand Down
61 changes: 30 additions & 31 deletions python/ribasim/ribasim/schemas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,22 @@ class Config:
coerce = True


class BasinBoundaryconcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
drainage_concentration: Series[float] = pa.Field(nullable=True)
precipitation_concentration: Series[float] = pa.Field(nullable=True)
urban_runoff_concentration: Series[float] = pa.Field(nullable=True)


class BasinConcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
concentration: Series[float] = pa.Field(nullable=False)


class BasinProfileSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
area: Series[float] = pa.Field(nullable=False)
Expand Down Expand Up @@ -48,23 +64,6 @@ class BasinTimeSchema(_BaseSchema):
urban_runoff: Series[float] = pa.Field(nullable=True)


# No capital for concentration to get Basin / boundaryconcentration
class BasinBoundaryconcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
drainage_concentration: Series[float] = pa.Field(nullable=True)
precipitation_concentration: Series[float] = pa.Field(nullable=True)
urban_runoff_concentration: Series[float] = pa.Field(nullable=True)


class BasinConcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
concentration: Series[float] = pa.Field(nullable=False)


class DiscreteControlConditionSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
listen_node_type: Series[str] = pa.Field(nullable=False)
Expand All @@ -80,6 +79,13 @@ class DiscreteControlLogicSchema(_BaseSchema):
control_state: Series[str] = pa.Field(nullable=False)


class FlowBoundaryConcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
concentration: Series[float] = pa.Field(nullable=False)


class FlowBoundaryStaticSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
active: Series[pa.BOOL] = pa.Field(nullable=True)
Expand All @@ -92,19 +98,19 @@ class FlowBoundaryTimeSchema(_BaseSchema):
flow_rate: Series[float] = pa.Field(nullable=False)


class FlowBoundaryConcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
concentration: Series[float] = pa.Field(nullable=False)


class FractionalFlowStaticSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
fraction: Series[float] = pa.Field(nullable=False)
control_state: Series[str] = pa.Field(nullable=True)


class LevelBoundaryConcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
concentration: Series[float] = pa.Field(nullable=False)


class LevelBoundaryStaticSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
active: Series[pa.BOOL] = pa.Field(nullable=True)
Expand All @@ -117,13 +123,6 @@ class LevelBoundaryTimeSchema(_BaseSchema):
level: Series[float] = pa.Field(nullable=False)


class LevelBoundaryConcentrationSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
time: Series[Timestamp] = pa.Field(nullable=False)
substance: Series[str] = pa.Field(nullable=False)
concentration: Series[float] = pa.Field(nullable=False)


class LevelDemandStaticSchema(_BaseSchema):
node_id: Series[int] = pa.Field(nullable=False, default=0)
min_level: Series[float] = pa.Field(nullable=False)
Expand Down
3 changes: 2 additions & 1 deletion python/ribasim_testmodels/ribasim_testmodels/basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from collections.abc import Sequence
from pathlib import Path
from typing import Any

Expand Down Expand Up @@ -116,7 +117,7 @@ def basic_model() -> ribasim.Model:
model.pump.add(Node(7, Point(4.0, 1.0)), [pump.Static(flow_rate=[0.5 / 3600])])

# Setup flow boundary
flow_boundary_data = [
flow_boundary_data: Sequence[TableModel[Any]] = [
flow_boundary.Static(flow_rate=[1e-4]),
flow_boundary.Concentration(
time="2020-01-01 00:00:00", substance=["Tracer"], concentration=[1.0]
Expand Down
Loading