Proposed new file structure

[rickecon]

@jdebacker. I propose we update the file structure in this repo with the following changes. The main thrust of these changes is to remove redundancy and increase intuition of where stuff is located. I can make the changes in the code to reflect these changes.

• Remove the extra /MacroAgingNaturSimulations/ folder under SimulationCode/simulation_results/.
• Remove the /Results/ directory and change the location of its contents
  • Move figures.py and the associated images directory to be directly under /SimulationCode/
  • Move the macro_aging_results.csv to be in the /SimulationCode/simulation_results/ directory

PROPOSED DIRECTORY STRUCTURE

MacroAgingNature (main directory)

• .gitignore
• environment.yml
• LICENSE
• README.md
• run_macro_aging.sh
• /Data/
• /SimulationCode/
  • figures.py
  • process_results.py
  • scenarios.json
  • simulation.py
  • /images/
    • us_popdiff_2nd1stgen.png
  • /simulation_results/
    • demog_vars_baseline.pkl
    • fert_rates_baseline.pkl
    • macro_aging_results.csv
    • /1st_gen/
    • /1st_gen_18pt5pct/
    • /2nd_gen/
    • /2nd_gen_ooc/
    • /baseline/
    • /brain/
    • /one_year_all/
    • /one_year_all_65plus/
    • /reproductive_1yr/
• /SurveyData/

[jdebacker]

@rickecon Yes, the two levels (MacroAgingNatureSimulations\simulation_results) seems like overkill since this repo only has results for the Nature Aging submission, so I agree one level should be removed and I like your suggestion here. As a note, the MacroAgingNatureSimulations level is set in the scenarios.json file, while simulation.py adds the simulation_results level.

I would like to make one change from what you suggest. I would like to see \SimulationCode\simulation_results only contain the raw model output. I would like to see the processed output in something like .\Results at the top-level directory. The reason is that I envision people just going directly to those and not wanting to dig through directories with code. Perhaps something like:

• \Results\ (or something more to the point of "results in the paper")
  • macro_aging_results.csv
  • \Figures\
    • us_popdiff_2nd1stgen.png
    • Other images from paper as png files
  • \Tables\
    • Tables: either all in one excel file or separate TeX/CSV/md or whatever files for each table

[rickecon]

I made those updates in PR #6. @jdebacker