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.

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

Brief introduction on network/graph #663

Open
1 task done
ArdtK opened this issue Dec 16, 2024 · 0 comments
Open
1 task done

Brief introduction on network/graph #663

ArdtK opened this issue Dec 16, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone.

Comments

@ArdtK
Copy link
Contributor

ArdtK commented Dec 16, 2024

Ra2ce version checks

  • I have checked that the issue still exists on the latest version of the docs in master here.

Kind of issue

Documentation is missing

Location of the documentation

https://deltares.github.io/ra2ce/network_module/network_module.html

Documentation problem

Current documentation is not complete.

Suggested fix for documentation

Add concise documentation on:

  • What is a network
  • What is an hazard overlay
  • What is a graph
  • What is a multi- and di-graph
  • Which sources are available for which type (OSM, etc)
  • Which is used when (Damages, Losses)
  • Which files are involved (.p, .csv, etc)

N.B.: The link in the issue template doesn't exist.

@ArdtK ArdtK added documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone. labels Dec 16, 2024
@ArdtK ArdtK self-assigned this Dec 16, 2024
@ArdtK ArdtK added this to the Sprint 2024 Q4.4 milestone Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone.
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant