[WIP] Updated package structure

NREL / CoolerChips

BSD 3-Clause "New" or "Revised" License

0 stars 2 forks source link

[WIP] Updated package structure #22

Open orionarcher opened 1 week ago

orionarcher commented 1 week ago

This PR implements several changes to the package structure that start to implement some SWE best practices. @jmythms

Namely:

testing structure
documentation
continuous integration actions
packaging

A few points to discuss before merging this in:

what can/should be tested?
where should data files be stored and what python files need to be updated?

jmythms commented 1 week ago

@orionarcher This is awesome, thank you! I am trying to test this locally. Can you list out a few steps on everything to do to test all the different features?