Breakthrough-Energy / REISE.jl

Renewable Energy Integration Simulation Engine
https://breakthrough-energy.github.io/docs/
MIT License
30 stars 22 forks source link

Refactor REISE.jl to comply with a standard style guide #152

Closed lanesmith closed 2 years ago

lanesmith commented 3 years ago

:rocket:

Describe the workflow you want to enable

There would be no change to how users interact with REISE.jl or how REISE.jl functions.

Describe your proposed implementation

Refactor the modules of REISE.jl to follow a single standard style guide. In the past, we have discussed following the Blue style guide.

danielolsen commented 3 years ago

We should probably also add an automated workflow to check compliance for new code, like we do for black.

rouille commented 3 years ago

You can also create a docs folder enclosing the details of the model (equations, etc.) that would be written in ReST (great for LaTeX!) and have a more succinct README as we have for PowerSimData.