pypsa-meets-earth/pypsa-earth

Execution of prepare_gas_network not regulated by __main__

Open

#1,655 opened on Mar 6, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (349 forks)auto 404
good first issuepypsa-earth-sec transfer

Repository metrics

Stars
 (351 stars)
PR merge metrics
 (Avg merge 28d 15h) (35 merged PRs in 30d)

Description

Describe the feature you'd like to see

The execution of the script of prepare_gas_network does not occur using the typical main, but it is executed at import. Usually we desire something like:

if __name__ == "__main__":
   call_func_do_stuff()

but in our case it is a mix:

if __name__ == "__main__":
   something()

call_func_do_lots_of_stuff()

That can be difficult to maintain

Contributor guide

Research direction
Find the prepare gas network script, identify all code executed outside the `if name == " main ":` block, and wrap it appropriately. Ensure the script's functionality is preserved after refactoring.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90