chore: create a design folder for capacity planning, design transmission, scenario info

[dmuldrew]

@ben, @danielolsen, @BainanXia, this PR just includes folder restructuring we discussed:

create powersimdata/design/ folder and move the generation capacity framework along with theScenarioInfo object therein. The design_transmission module will be moved there too --> 1 PR

[rouille]

Looks good. Thanks for doing that!

Try to use present tense in your commit message in the future. This is the convention we came up with:
https://github.com/intvenlab/REISE/wiki/Software-Development-Guidelines

New folder design required

[rouille]

It seems like you did not move powersimdata/input/tests/test_design_transmission.py

[rouille]

Also, you will need to update the following:

powersimdata/input/change_table.py:4:from powersimdata.input.design_transmission import (
powersimdata/input/change_table.py:299:        Optional kwargs as documented in powersimdata.input.design_transmission
powersimdata/input/change_table.py:307:        Optional kwargs as documented in powersimdata.input.design_transmission

[BainanXia]

test_scenario_info.py needs to be moved accordingly as well...

[dmuldrew]

I've taken care of moving the test files mentioned above and updating change table import paths. Looks like there's still an issue with the ScenarioInfo tests failing, @BainanXia can you take a look at that...

[BainanXia]

@dmuldrew It's just about the import paths update. Fixed for both test_scenario_info.py and test_design_transmission.

[rouille]

All tests pass.

Can you do an interactive rebase to keep only essential commit messages (fixup command) using git rebase -i HEAD~7. Please, start the message with a verb in the present tense (see https://github.com/intvenlab/REISE/wiki/Software-Development-Guidelines). Thanks.

[kasparm]

README.md adjustments needed.

[danielolsen]

Please rename powersimdata/design/design_transmission.py to powersimdata/design/transmission.py (and change associated imports).

Please rename powersimdata/design/demo/data/Eastern Scenario Take 2.csv to something more meaningful.

[rouille]

The __all__ variable needs to be updated with the module names in design.
The clean_capacity_scaling module has lot of docstrings where type of argumentsare not specified, have missing arguments or do not follow our convention.

[BainanXia]

As we discussed before, there should be a data folder in the tests folder to handle all test related data files as well. Also, @danielolsen 's requests on renaming files are not addressed. Based on the decision @rouille mentioned in the meeting, the docstrings of clean_capacity_scaling is going to be fixed in another PR after this.

[dmuldrew]

I put a data folder in demo because it was needed for the demo notebook:
https://github.com/intvenlab/PowerSimData/tree/folder_reorganization/powersimdata/design/demo
None of my tests use external data files, so I'm not sure it makes sense to create an data empty folder.

I'll take care of the file rename for Daniel...

[BainanXia]

None of my tests use external data files

What does test_case_input_output.csv do? If we don't need it, then we should remove it from the package.

[dmuldrew]

OK, I see now...I created that earlier and never used it. I'll remove it.

[rouille]

It looks like you did not change the import statements, __init__ and test file after renaming design_transmission to transmission:

• test_design_transmission.py --> test_transmission.py
• powersimdata/design/tests/test_design_transmission.py:from powersimdata.design.design_transmission import (
• powersimdata/input/init.py:all = ['abstract_grid', 'change_table', 'csv_reader', 'design_transmission', --> needs to be removed
• powersimdata/input/change_table.py:from powersimdata.design.design_transmission import (
• powersimdata/input/change_table.py: Optional kwargs as documented in powersimdata.design.design_transmission
• powersimdata/input/change_table.py: Optional kwargs as documented in powersimdata.design.design_transmission

This is why the tests are failing:

(v1) [~/REM/PowerSimData] (folder_reorganization) brdo$ pytest . --verbose
================================================================ test session starts =================================================================
platform darwin -- Python 3.6.5, pytest-4.5.0, py-1.8.0, pluggy-0.13.0 -- /Users/brdo/PyEnv/REM/v1/bin/python
cachedir: .pytest_cache
rootdir: /Users/brdo/REM/PowerSimData
collected 55 items / 2 errors / 53 selected                                                                                                          

======================================================================= ERRORS =======================================================================
_______________________________________ ERROR collecting powersimdata/design/tests/test_design_transmission.py _______________________________________
ImportError while importing test module '/Users/brdo/REM/PowerSimData/powersimdata/design/tests/test_design_transmission.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
powersimdata/design/tests/test_design_transmission.py:7: in <module>
    from postreise.tests.mock_scenario import MockScenario
../PostREISE/postreise/tests/mock_scenario.py:1: in <module>
    from powersimdata.scenario.scenario import Scenario
powersimdata/scenario/scenario.py:6: in <module>
    from powersimdata.scenario.create import Create
powersimdata/scenario/create.py:5: in <module>
    from powersimdata.input.change_table import ChangeTable
powersimdata/input/change_table.py:4: in <module>
    from powersimdata.design.design_transmission import (
E   ModuleNotFoundError: No module named 'powersimdata.design.design_transmission'
__________________________________________ ERROR collecting powersimdata/design/tests/test_scenario_info.py __________________________________________
ImportError while importing test module '/Users/brdo/REM/PowerSimData/powersimdata/design/tests/test_scenario_info.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
powersimdata/design/tests/test_scenario_info.py:5: in <module>
    from postreise.tests.mock_scenario import MockScenario
../PostREISE/postreise/tests/mock_scenario.py:1: in <module>
    from powersimdata.scenario.scenario import Scenario
powersimdata/scenario/scenario.py:6: in <module>
    from powersimdata.scenario.create import Create
powersimdata/scenario/create.py:5: in <module>
    from powersimdata.input.change_table import ChangeTable
powersimdata/input/change_table.py:4: in <module>
    from powersimdata.design.design_transmission import (
E   ModuleNotFoundError: No module named 'powersimdata.design.design_transmission'
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 2 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
============================================================== 2 error in 2.62 seconds ===============================================================

[BainanXia]

This is nice. All tests passed and the folders are reorganized based on our proposal. Thanks!

[rouille]

@dmuldrew had to pass the batton since he had to finish writing out the code for the grid scaling framework. I did the following before merging this PR:

• update import statements throughout PowerSimData after the powersimdata.design.design_transmission module has been renamed as powersimdata.design.transmission.
• rename Eastern Scenario Take 2.csv to eastern_2030_clean_energy_targets.csv and EasternCleanCapacityScaling.ipynb to eastern_clean_capacity_scaling_demo.ipynb. Also update import statements in notebook and input csv file.
• remove unnecessary __init__ modules in demo and data folders.
• update __all__ in powersimdata.input.__init__ after moving module.
• update docstring in powersimdata.design.clean_capacity_scaling module