Structure: Packages and functions

[gotom22]

analogous to flowchart, outline structure for packages, (and I believe functions within these). I assume this would look very similar to "modules" (?)

Complete package "ITHIM-R"

• includes generic ITHIM functions used in mulitple packages (?) P1 "Scenario Definition"
  • includes functions used in P1 P2 "Synthetic population" etc.

just thinking out loud here. Pls add suggest what this "packages outline" should include

[gotom22]

I identify the following tasks re "tool structure":

• [x] define and name "main ITHIM-R modules": These should reflect both project structure (i.e. work packages) and tool structure (i.e. main steps of workflow) as much as possible, but do not necessarily overlap fully. See https://github.com/ITHIM/ITHIM-R/wiki/ITHIM-R-modules
• [ ] update flow chart, Wiki and similar documentation accordingly
• [x] define GitHub Projects, and label and assign issues accordingly.
• [ ] identify and assign tasks within GH projects/Modules
• [ ] schedule topical calls rotating through main GH projects/Modules

[gotom22]

and this may help understand why I think of this side-by-side with the tool/interface structure (maybe more so than others do)...

Project Modules	Interface Modules (tabs)
1. Data sources	- data upload features. data requirement instructions
2. Data localization	- for now maybe just instructions on how to localize data. later maybe some scaling tool.
3. Data harmonization	- some interface where user specifies age, mode and other categories they provide. Tool then maps this to synt.pop. definitions.
4. Synthetic "baseline" population	- Maybe no interface. Maybe some "methods inputs" could be asked here from the user (e.g. matching variables to link datasets
5. Scenario Definition (3 options:)	- user gets to choose "user provided "scenario population data" (i.e. back to step 1)", "predefined scenarios (i.e. manipulations of baseline pop)", or "user defined (manipulations of baseline pop. data through sliders etc.)"
6. Exposure calculations	- Maybe no interface. Maybe some methods inputs
7. Impact pathway calculations	- Maybe no interface. Maybe some methods inputs
8. Results presentations	- user can specifiy how results are presented. And look at them

see Wiki for submodules

[gotom22]

@JDWoodcock re https://github.com/ITHIM/ITHIM-R/wiki/Tool-architecture

I think for an "outsider" it would be cleaner to have "exposure calculation" applied to both baseline and scenario population data in the same step, same way. as illustrated below. (My sense is you interpret PA and travel data as "ready to use exposures"...but I am not sure this is intuitive for all....and certainly not the case for air pollution. So there is also an explicit exposure calculation step for baseline, and the math is the same as for scenario. ITHIM-R_v8_exp_calc_same for BL and Scenario.pdf