search

rl-institut / smooth

Simulation framework for non-linear state-dependant energy systems
Other
6 stars 7 forks source link

Rtd components #214

Closed ciaradunks closed 3 years ago

ciaradunks commented 3 years ago

This PR is created to include the readthedocs documentation for SMOOTH. It includes a 'Getting started' page with four main sections: components, examples, framework and optimization.

ToDo: include diagrams for run_smooth and run_optimization

j-brendel commented 3 years ago

As for the general structure I think it would make sense to have the idea of what smooth does and what the optimization does somewhere prominent at the beginning. I would propose to add a section in getting started after "Installing smooth" and before "Structure of the smooth modulle" where it is briefly explained. It would just be like: SMOOTH solves an explicitly defined energy system with several components, such as electrolyzers or a hydrogen storages. The results are the flows in and out of each component as well as their states for all timesteps defined for the simulation and the associated emissions and costs, which are capital expenditures (CAPEX), operational expenditures (OPEX) and variable costs. The SMOOTH optimization can be used additionally. It finds an optimal energy system by varying key parameters of the components, such as power or capacity and simulating these modified systems using SMOOTH. The optimization than evaluates all individual energy systems according to two objective functions, that can be defined to measure the performance of each system. Finally the specifications of the best suited systems are given as results.