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

Update module structure #714

Closed
wants to merge 34 commits into from
Closed

Conversation

ClaraBuettner
Copy link
Contributor

@ClaraBuettner ClaraBuettner commented Jan 30, 2024

This branch slightly adjusts the structure of etrago. There are now more submodules, and especially the tools module is now smaller.
The different modules are quite similar to the flow-chart we often use to show the functionalities of eTraGo, which makes it easier to combine both. The structure now looks like this:

  • etrago
  • etrago.appl
  • etrago.network
  • etrago.analyze
    -- etrago.analyze.calc_results
    -- etrago.analyze.plot
  • etrago.cluster
    -- etrago.cluster.electrical
    -- etrago.cluster.gas
    -- etrago.cluster.snaphot
    -- etrago.cluster.spatial
  • etrago.disaggregate
    -- etrago.disaggregate.spatial
    -- etrago.disaggregate.temporal
  • etrago.execute
    -- etrago.execute.grid_optimization
    -- etrago.execute.market_optimization
    -- etrago.execute.sclopf will be added
  • etrago.tools
    -- etrago.tools.io
    --- etrago.tools.io.db
    -- etrago.tools.constraints
    -- etrago.tools.extendable
    -- etrago.tools.utilities

I am not sure if that is the very best structure but it is in my opinion already an improvement to the modules before, where many things were in the tools module. It might make sense to move e.g. constraints and extendable to the execute module. We can discuss the structure. This setting is already working, the tool itself and als the rtd is working fine.

ClaraBuettner and others added 27 commits January 6, 2024 11:08
Before this change, the H2_grid nodes were not clustered at all since "H2" was never in the list of carriers
There were several problems with the import when there is an io module in the working directory. To avoid these, the module remains a submodule of tools
@ClaraBuettner
Copy link
Contributor Author

@ulfmueller: Do you have any thoughts/concerns on this?

@ClaraBuettner ClaraBuettner marked this pull request as ready for review February 1, 2024 15:45
Copy link
Member

@ulfmueller ulfmueller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't test if everything works as intended but generally I am fine with the new structure. As discussed it seems to be an improvement without being THE 'perfect' solution...

@ClaraBuettner
Copy link
Contributor Author

Closed in favor of #752

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 this pull request may close these issues.

3 participants