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

restructure files #128

Open
claytonpbarrows opened this issue Jan 20, 2021 · 3 comments
Open

restructure files #128

claytonpbarrows opened this issue Jan 20, 2021 · 3 comments
Milestone

Comments

@claytonpbarrows
Copy link
Member

I plan to improve the file structure of this repo. A proposal for the new structure follows:

  • src # scripts for tool specific data conversion
  • data # the source data
  • dist # tool specific formatted versions
    • unsupported # formatted versions without programmatic conversions and CI
    • PandaPower
    • Plexos
    • Prescient
    • MATPOWER
    • ...
  • test # CI tests for tool formatters
@claytonpbarrows claytonpbarrows added this to the reformat milestone Jan 20, 2021
@GordStephen
Copy link
Contributor

In the spirit of brainstorming, could I suggest splitting the "canonical" data and the tool-specific formats into separate repositories? Or better yet, canonical data + one repository per tool? That would make the respective commit histories a lot more informative, and also decentralize the process of adding new formats (stewarding the system specification and maintaining a dozen different implementations of that specification are fairly distinct tasks and you/NREL/the IEEE TF doesn't necessarily need to be involved in the latter).

@claytonpbarrows
Copy link
Member Author

Makes sense.

@GordStephen
Copy link
Contributor

Cool. You should still be able to pull in a whitelisted set of format generators as part of a CI workflow, if you want to automatically generate new formatted data whenever the spec changes. If you want help just let me know!

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

No branches or pull requests

2 participants