Skip to content

docs: surface vertical API in reference #653

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

Merged
ecomodeller merged 1 commit into from
May 18, 2026
Merged

docs: surface vertical API in reference #653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 19 additions & 2 deletions docs/_quarto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ website:
- api/TrackObservation.qmd
- api/NodeObservation.qmd
- api/ReachObservation.qmd
- api/VerticalObservation.qmd
- section: "Model Result"
href: api/model.qmd
contents:
Expand All @@ -93,6 +94,7 @@ website:
- api/GridModelResult.qmd
- api/DummyModelResult.qmd
- api/NetworkModelResult.qmd
- api/VerticalModelResult.qmd
- section: "Matching"
contents:
- api/match.qmd
Expand All @@ -106,9 +108,13 @@ website:
href: api/comparison.ComparerPlotter.qmd
- api/ComparerCollection.qmd
- text: "ComparerCollectionPlotter"
href: api/comparison.ComparerCollectionPlotter.qmd
href: api/comparison.ComparerCollectionPlotter.qmd
- text: "VerticalAccessor"
href: api/comparison.VerticalAccessor.qmd
- text: "VerticalPlotter"
href: api/comparison.VerticalPlotter.qmd
- section: "Skill"
contents:
contents:
- api/SkillTable.qmd
- text: "SkillArray"
href: api/skill.SkillArray.qmd
Expand All @@ -118,6 +124,10 @@ website:
href: api/skill_grid.SkillGrid.qmd
- text: "SkillGridArray"
href: api/skill_grid.SkillGridArray.qmd
- text: "SkillProfile"
href: api/skill_profile.SkillProfile.qmd
- text: "SkillProfileArray"
href: api/skill_profile.SkillProfileArray.qmd
- text: "Plotting"
href: api/plotting.qmd
contents:
Expand Down Expand Up @@ -172,6 +182,7 @@ quartodoc:
- TrackObservation
- NodeObservation
- ReachObservation
- VerticalObservation
- title: Model Result
desc: ""
contents:
Expand All @@ -184,6 +195,7 @@ quartodoc:
- GridModelResult
- DummyModelResult
- NetworkModelResult
- VerticalModelResult
- title: Matching
desc: Matching functions
contents:
Expand All @@ -198,6 +210,7 @@ quartodoc:
- name: Comparer
members:
- plot
- vertical
- skill
- gridded_skill
- score
Expand Down Expand Up @@ -228,6 +241,8 @@ quartodoc:
- save
- load
- name: comparison.ComparerCollectionPlotter
- name: comparison.VerticalAccessor
- name: comparison.VerticalPlotter

- title: Skill
desc: ""
Expand All @@ -237,6 +252,8 @@ quartodoc:
- name: skill.SkillArrayPlotter
- name: skill_grid.SkillGrid
- name: skill_grid.SkillGridArray
- name: skill_profile.SkillProfile
- name: skill_profile.SkillProfileArray

- title: Plotting
desc: ""
Expand Down
3 changes: 3 additions & 0 deletions src/modelskill/comparison/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@
from ._collection import ComparerCollection
from ._comparer_plotter import ComparerPlotter
from ._collection_plotter import ComparerCollectionPlotter
from ._vertical_comparison import VerticalAccessor, VerticalPlotter


__all__ = [
"Comparer",
"ComparerCollection",
"ComparerPlotter",
"ComparerCollectionPlotter",
"VerticalAccessor",
"VerticalPlotter",
]
Loading