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

Efficient directory names #63

Closed
e-lo opened this issue Jun 12, 2023 · 6 comments · Fixed by #72
Closed

Efficient directory names #63

e-lo opened this issue Jun 12, 2023 · 6 comments · Fixed by #72

Comments

@e-lo
Copy link
Contributor

e-lo commented Jun 12, 2023

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
@e-lo
Copy link
Contributor Author

e-lo commented Jun 12, 2023

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

@e-lo
Copy link
Contributor Author

e-lo commented Jun 12, 2023

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

@ssmith55
Copy link
Collaborator

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.

@pedrocamargo
Copy link

Excellent suggestion

@ssmith55
Copy link
Collaborator

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

@ssmith55
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants