Multi invest bug

[samgdotson]

This PR fixes the multi-investment issue where PyPSA was using generators from future years in earlier ones. Closes #40.

Why should we use pull requests to collaborate?

1. Pull requests serve as a built-in QA/QC step when developing research code and software.
2. The discussions within issues and pull requests document the rationale for certain decisions for future use.
3. Critically reviewing other people's code (and having your own code critically reviewed) is a great way to improve coding skills.
4. Pull requests don't have to be reviewed by someone working on the same project. Thus, PRs allow greater cross-program collaboration and break down silos.
5. Similarly, PRs allow interested third parties to meaningfully contribute to open-source projects. In the case of UCS, that may include enthusiastic members of the science network.
6. PRs protect your data and repository by preventing force pushes. In many cases, at least one other person must review the code before it is "merged" with the main code base.

Where to focus attention

The following files should be prioritized for review:

• All files in the scripts/ folder (these should be python source files, 8 in total).
• All files in the utils/ folder (these should be python source files, 2 in total).
• The Snakefile file
• The config.yml file

The jupyter notebook files can be ignored since they are experimental and will be removed in a future pull request.

How to review a pull request

This post goes over the steps for reviewing a pull request.

Recommended checklist for reviewing a pull request

The guide below is modified from the Advanced Reactors and Fuel Cycles (ARFC) research group at the University of Illinois Urbana-Champaign

• Read the PR description
• Read through all the changes, considering the following questions.
  • Is there anything you can praise about this PR? Start with
    praise.
  • Are variable names brief but descriptive?
  • Are new/changed functions no longer than a paragraph?
  • Do all function parameters have default values where appropriate?
  • Is the code clear and clean? (see Robert C. Martin's
    Clean Code
    • If something is unclear, ask for clarification
    • Can you offer a suggestion to make the functionality clearer?
  • Is there enough documentation?
  • Does the programming style meet the requirements of the
    repository (PEP8 for python,
    google C++ style guide, etc.)
  • If a new feature has been added, or a bug fixed, has a test been
    added to confirm good behavior?
  • Does the test actually test the new/changed functionality?
  • Does the test successfully test edge cases?
  • Does the test successfully test corner cases?
  • If the repository has continuous integration: does the PR pass
    the tests?
  • If there is no continuous integration, check out the branch
    locally, build, and run the tests.
  • Do the tests pass on your machine?
  • Is the PR free of random cruft (built files, .swp files,
    etc.)?
  • Do all files in the PR belong in the repository?
  • If the PR deletes files, is this appropriate?
  • If the PR adds files or data, are these new files compatible
    with the repository license?
  • Make a review, leaving kind comments and suggesting changes
    where needed (to resolve the above).
  • Has the author resolved all of the comments and suggestions
    in your review?
• When you approve of the PR, merge and close it.
• Does this PR close an issue? If so, be sure to descriptively
  close this issue when the PR is merged
• Thank the author for th

[pep8speaks]

Hello @samgdotson! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file scripts/add_electricity.py:

Line 17:5: W291 trailing whitespace
Line 19:1: E722 do not use bare 'except'
Line 21:1: W293 blank line contains whitespace
Line 23:80: E501 line too long (81 > 79 characters)
Line 24:1: E722 do not use bare 'except'
Line 399:1: W293 blank line contains whitespace
Line 401:1: W293 blank line contains whitespace
Line 403:80: E501 line too long (83 > 79 characters)
Line 404:1: W293 blank line contains whitespace
Line 411:1: W293 blank line contains whitespace
Line 413:1: W293 blank line contains whitespace
Line 415:29: E127 continuation line over-indented for visual indent
Line 416:29: E127 continuation line over-indented for visual indent
Line 417:29: E127 continuation line over-indented for visual indent
Line 418:29: E127 continuation line over-indented for visual indent
Line 419:29: E127 continuation line over-indented for visual indent
Line 420:29: E127 continuation line over-indented for visual indent
Line 421:29: E124 closing bracket does not match visual indentation
Line 424:1: W293 blank line contains whitespace
Line 430:1: W293 blank line contains whitespace
Line 432:1: W293 blank line contains whitespace
Line 435:1: W293 blank line contains whitespace
Line 441:29: E127 continuation line over-indented for visual indent
Line 442:29: E127 continuation line over-indented for visual indent
Line 443:29: E127 continuation line over-indented for visual indent
Line 444:29: E127 continuation line over-indented for visual indent
Line 445:29: E127 continuation line over-indented for visual indent
Line 446:29: E127 continuation line over-indented for visual indent
Line 447:29: E124 closing bracket does not match visual indentation
Line 450:1: W293 blank line contains whitespace
Line 453:1: E302 expected 2 blank lines, found 1
Line 456:66: W291 trailing whitespace
Line 460:1: W293 blank line contains whitespace
Line 462:1: W293 blank line contains whitespace
Line 464:1: W293 blank line contains whitespace
Line 472:25: E128 continuation line under-indented for visual indent
Line 473:25: E128 continuation line under-indented for visual indent
Line 474:25: E128 continuation line under-indented for visual indent
Line 475:25: E128 continuation line under-indented for visual indent
Line 476:25: E128 continuation line under-indented for visual indent
Line 477:25: E128 continuation line under-indented for visual indent
Line 480:1: W293 blank line contains whitespace
Line 482:1: W293 blank line contains whitespace
Line 542:5: E303 too many blank lines (2)
Line 544:1: W293 blank line contains whitespace
Line 567:80: E501 line too long (81 > 79 characters)

• In the file scripts/build_base_network.py:

Line 11:1: E302 expected 2 blank lines, found 1
Line 21:45: E127 continuation line over-indented for visual indent
Line 22:45: E127 continuation line over-indented for visual indent
Line 24:1: W293 blank line contains whitespace
Line 25:80: E501 line too long (82 > 79 characters)
Line 27:1: W293 blank line contains whitespace
Line 28:42: E231 missing whitespace after ','

• In the file scripts/plot_results.py:

Line 18:38: W291 trailing whitespace
Line 19:1: W293 blank line contains whitespace
Line 24:1: W293 blank line contains whitespace
Line 184:1: W293 blank line contains whitespace
Line 186:33: E231 missing whitespace after ','
Line 186:80: E501 line too long (80 > 79 characters)
Line 188:80: E501 line too long (83 > 79 characters)
Line 189:80: E501 line too long (86 > 79 characters)
Line 190:80: E501 line too long (86 > 79 characters)
Line 191:80: E501 line too long (88 > 79 characters)
Line 194:1: W293 blank line contains whitespace
Line 195:71: E231 missing whitespace after ','
Line 195:80: E501 line too long (93 > 79 characters)
Line 208:43: E231 missing whitespace after ','
Line 251:5: E303 too many blank lines (2)

Comment last updated at 2024-09-11 16:26:45 UTC

[lshaver]

With the suggested changes I approve this PR. Lots of good work here!