Skip to content

Restructure input data for example models#672

Merged
tsmbland merged 19 commits intomainfrom
input_structure
Mar 27, 2025
Merged

Restructure input data for example models#672
tsmbland merged 19 commits intomainfrom
input_structure

Conversation

@tsmbland
Copy link
Copy Markdown
Collaborator

@tsmbland tsmbland commented Mar 13, 2025

Description

Restructuring the example models to be clearer for new users.

Easiest just to look at the new version of the default model

Main changes:

  • got rid of the "Technodata" folder - sector folders now live at the top level
  • renamed the "preset" folder to "residential_presets" to match the sector name
  • got rid of the "inputs" folder - these files now live at the top level (along with the "Agents.csv" file in cases where agents are shared between sectors)
  • removed the "BaseYearImport" and "BaseYearExport" files as these weren't being used
  • removed some optional parameters from the settings file (lpsolver, constraints, dispatch_production, demand_share)
  • restructured the settings file to a more logical order (e.g. outputs at the end)
  • updated wizard.py to work with the new structure
  • deleted test_factory_constraints_passed_to_agents because it was annoying me (oops)

This is just about changing the example models rather than the code, so shouldn't have any effect on other models. Users can still structure their files however they want as long as they link their files properly in the settings file, but I think the structure here is simpler/less convoluted than what we had before so should be clearer for new users.

Notes:

Fixes #666

@tsmbland
Copy link
Copy Markdown
Collaborator Author

@martinstringer Have a quick look at the default model linked above and let me know what you think. I'm not changing the contents of any of the files (except the settings file), just restructuring.

It's almost what we discussed, but I've got rid of the input/global_input_files folder as I don't really think it's necessary.

All just convention though, any structure will still work as long as the files are linked correctly in the settings file

@tsmbland tsmbland requested a review from martinstringer March 20, 2025 14:53
@tsmbland tsmbland marked this pull request as ready for review March 20, 2025 14:53
@tsmbland tsmbland moved this to 👀 In review in MUSE Mar 21, 2025
@tsmbland tsmbland requested a review from dalonsoa March 26, 2025 09:05
@tsmbland
Copy link
Copy Markdown
Collaborator Author

@dalonsoa This one's probably annoying to review and I'm keen to avoid marge conflicts so going to merge now

@tsmbland tsmbland merged commit 882b940 into main Mar 27, 2025
14 checks passed
@tsmbland tsmbland deleted the input_structure branch March 27, 2025 12:43
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in MUSE Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Simplify folder structure of input data

1 participant