DHI / DHI/modelskill

Hide internal network integer IDs from public API where possible (future improvement)

Open
#639 0 comments 0 reactions 1 assignee Claimed by @jpalm3r View on GitHub
Dominant language
Python
Stars
56
Forks
9
Avg merge
57m
Merged PRs (30d)
3

Description

__Problem:__ users may be exposed to internal abstract-network integer node IDs that do not map 1:1 to familiar Res1D identifiers.

__Goal:__ keep public workflows centered on user-facing identifiers (Res1D node names and (edge, chainage) for gridpoints/breakpoints), minimizing need to track internal IDs.

__Scope ideas:__
- Audit user-facing APIs/docs for internal ID leakage.
- Prefer alias-based interfaces in matching/extraction.
- Add migration/deprecation notes if any public behavior changes.
- Validate with tester feedback before enforcing stricter hiding.

__Acceptance criteria:__
- Typical workflows do not require users to manually map internal IDs.
- Docs clearly describe canonical user-facing identifiers.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.