Efficient directory names

Question

Efficient directory names

e-lo opened this issue a year ago · 6 comments

As a programatic user, I'd like to more efficiently navigate the GMNS spec directory and not worry about fussy capitalization.

If approved by community, I (@e-lo) am happy to implement.

Proposed solution

Adopt following folder structure:

spec\
examples\ #small network examples dir...without stray .csvs in base dir
usage\ #example validation and usage notebooks, currently in validation tools and conversion tools dir
docs\ 
  spec\ # all markdown versions of spec
  img\  # all image files

Answer 1 · 2023-06-12T16:44:41.000Z

Note that this structure will also more effectively support a future site with automated documentation generation.

Answer 2 · 2023-06-12T16:48:04.000Z

cc: @joecastiglione on if community would like me to implement.

Answer 3 · 2023-06-15T15:16:33.000Z

Thank you for the suggestion. Other users, notably AequilibraE, are using the current directory structure in some examples. I am fine with this change, but would like to save it for the next release, with advance notification to the user community.

Answer 4 · 2024-01-29T09:48:50.000Z

Excellent suggestion

Answer 5 · 2024-01-29T12:01:54.000Z

Let's do it, starting with the development (soon to be develop) branch.

Answer 6 · 2024-01-29T13:45:05.000Z

Done in the development branch. Now need to check for and fix broken links.
Conversion_Tools -> usage\conversion
Images -> docs\img
Small_Network_Examples -> examples
Specification -> spec
Specification_md -> docs\spec
Validation_Tools -> usage\validation