-
Notifications
You must be signed in to change notification settings - Fork 0
Population Size and Scaling
Home > Model Development Topics > Population Size and Scaling
This topic describes ways a model can specify the size of the simulation population, the size of the real-world population represented by the simulation population, and the scaling of table results to the size of the real-world population.
-
Use Modules: The
use
statement and supplied library ofuse
framework modules
- Introduction
- Population size and scaling - case-based model
- Population size and scaling - time-based model
The following concepts are used in this topic.
Term | Explanation |
---|---|
run | An execution of a model. A run can consist of one or more independent subs/members/replicates. |
member/replicate/sub/subsample | Synonyms denoting each of the independent simulations which together constitute a run. |
case | An independent, isolated entity or small collection of related entities such as a family or clan. |
case-based model | A model which simulates, in each sub/replicate, a population of independent, non-interacting cases. |
time-based model | A model which simulates, in each sub/replicate, a population of interacting entities. |
simulation population | The population of entities in a model simulation. |
real population | The real-world population represented by a simulation population. |
use module |
A code module supplied with OpenM++ which implements underlying functionality for a model. |
An OpenM++ model specifies population size and scaling in different ways depending on what kind of model it is. For example, a model which creates a synthetic population from multivariate distributions has no intrinsic size whereas a model based on a micro-data file may have its size fixed to the number of observations in that file.
To support different model frameworks OpenM++ includes a library of source code modules. Selected modules from this library are incorporated into a model through use
statements to implement the desired model framework. These use
statements are usually found in a model code module named ompp_framework.ompp
. For more information, please see the Use Modules topic.
Population size and scaling is specified for a case-based model by selecting a pair of modules from the use
library,
one which determines population size and one which determines population scaling.
For example, the following code fragment from the ompp_framework.ompp
module for a model specifies
that population size is given for the entire run (rather than for each replicate of the run),
and that the results are not scaled to a real population.
use "case_based/case_based_cases_per_run_exogenous.ompp";
use "case_based/case_based_scaling_none.ompp";
The following table lists the available choices to specify population size for a case-based model:
use module |
Description |
---|---|
case_based/case_based_cases_per_member_exogenous.ompp |
The number of cases in a member is given by the input parameter CasesPerMember which is declared in this module. The number of cases in the run is the product of CasesPerMember and the number of replicates specified for the run. |
case_based/case_based_cases_per_run_exogenous.ompp |
The number of cases for the entire run is given by the input parameter SimulationCases which is declared in this module. The cases are evenly divided among the members specified for the run. Any 'extra' cases are assigned to lower-numbered members. |
case_based/case_based_cases_per_member_endogenous.ompp |
The number of cases in a member is given endogenously by the derived parameter CasesPerMember , which is declared in this module. CasesPerMember is set by a PreSimulation function in model code. CasesPerMember might, for example, be set to the number of observations in a micro-data input file. The number of cases in the run is the product of CasesPerMember and the number of replicates specified for the run. NOT YET IMPLEMENTED
|
case_based/case_based_cases_per_run_endogenous.ompp |
The number of cases for the entire run is given endogenously by the derived parameter SimulationCases , which is declared in this module. SimulationCases is set by a PreSimulation function in model code. SimulationCases might, for example, be set to the number of observations in a micro-data input file. Model code would allocate observations in the micro-data file evenly to each of the members of the run, and allocate any 'extra' cases to lower-numbered members. NOT YET IMPLEMENTED
|
The following table shows the available choices to specify population scaling for a case-based model:
use module |
Description |
---|---|
case_based/case_based_scaling_exogenous.ompp |
The simulated population in each sub/member/replicate is scaled to represent the real-world population given by the input parameter SimulatedPopulation , which is declared in this module. Incorporates weights if model uses weighted tabulation. |
case_based/case_based_scaling_endogenous.ompp |
The simulated population in each sub/member/replicate is scaled to represent a real-world population provided by model code by a call to the global function SetPopulation(). Incorporates weights if model uses weighted tabulation. |
case_based/case_based_scaling_none.ompp |
The simulated population in each sub/member/replicate is scaled to the number of cases in the run. For a run with a single member, this is equivalent to no population scaling. For a run with more than one member, each member is scaled up by the number of members in the run. |
case_based/case_based_scaling_endogenous_or_none.ompp |
Acts like case_based_scaling_endogenous if the parameter DisablePopulationScaling is false , or like case_based_scaling_none if true . |
case_based/case_based_scaling_disable.ompp |
Disables population scaling. Each sub is scaled up by the number of subs, which causes overall (average) run results to become the sums of the original (unscaled) subs. |
Population size and scaling is specified for a time-based model by selecting a module from the use
library which determines both population size and scaling. All such modules declare a parameter StartingPopulationSize
which gices the size of the starting population. The size of the starting population is the same for all members of a time-based model run.
The following code fragment from the ompp_framework.ompp
module for a model specifies that results are not scaled.
use "time_based/time_based_scaling_none.ompp";
The following table shows the available choices to specify population size scaling for a time-based model:
use module |
Description |
---|---|
time_based/time_based_scaling_exogenous.ompp |
The simulated population in each member/replicate is scaled to represent the real-world population given by the input parameter SimulatedPopulation , which is declared in this module. |
time_based/time_based_scaling_endogenous.ompp |
The simulated population in each member/replicate is scaled to represent the real-world population given by the input parameter SimulatedPopulation , which is declared in this module. Or maybe by a call to the function SetPopulation(). NOT FULLY TESTED
|
time_based/time_based_scaling_none.ompp |
The simulated population in each member/replicate is not scaled. |
- Windows: Quick Start for Model Users
- Windows: Quick Start for Model Developers
- Linux: Quick Start for Model Users
- Linux: Quick Start for Model Developers
- MacOS: Quick Start for Model Users
- MacOS: Quick Start for Model Developers
- Model Run: How to Run the Model
- MIT License, Copyright and Contribution
- Model Code: Programming a model
- Windows: Create and Debug Models
- Linux: Create and Debug Models
- MacOS: Create and Debug Models
- MacOS: Create and Debug Models using Xcode
- Modgen: Convert case-based model to openM++
- Modgen: Convert time-based model to openM++
- Modgen: Convert Modgen models and usage of C++ in openM++ code
- Model Localization: Translation of model messages
- How To: Set Model Parameters and Get Results
- Model Run: How model finds input parameters
- Model Output Expressions
- Model Run Options and ini-file
- OpenM++ Compiler (omc) Run Options
- OpenM++ ini-file format
- UI: How to start user interface
- UI: openM++ user interface
- UI: Create new or edit scenario
- UI: Upload input scenario or parameters
- UI: Run the Model
- UI: Use ini-files or CSV parameter files
- UI: Compare model run results
- UI: Aggregate and Compare Microdata
- UI: Filter run results by value
- UI: Disk space usage and cleanup
- UI Localization: Translation of openM++
-
Highlight: hook to self-scheduling or trigger attribute
-
Highlight: The End of Start
-
Highlight: Enumeration index validity and the
index_errors
option -
Highlight: Simplified iteration of range, classification, partition
-
Highlight: Parameter, table, and attribute groups can be populated by module declarations
- Oms: openM++ web-service
- Oms: openM++ web-service API
- Oms: How to prepare model input parameters
- Oms: Cloud and model runs queue
- Use R to save output table into CSV file
- Use R to save output table into Excel
- Run model from R: simple loop in cloud
- Run RiskPaths model from R: advanced run in cloud
- Run RiskPaths model in cloud from local PC
- Run model from R and save results in CSV file
- Run model from R: simple loop over model parameter
- Run RiskPaths model from R: advanced parameters scaling
- Run model from Python: simple loop over model parameter
- Run RiskPaths model from Python: advanced parameters scaling
- Windows: Use Docker to get latest version of OpenM++
- Linux: Use Docker to get latest version of OpenM++
- RedHat 8: Use Docker to get latest version of OpenM++
- Quick Start for OpenM++ Developers
- Setup Development Environment
- 2018, June: OpenM++ HPC cluster: Test Lab
- Development Notes: Defines, UTF-8, Databases, etc.
- 2012, December: OpenM++ Design
- 2012, December: OpenM++ Model Architecture, December 2012
- 2012, December: Roadmap, Phase 1
- 2013, May: Prototype version
- 2013, September: Alpha version
- 2014, March: Project Status, Phase 1 completed
- 2016, December: Task List
- 2017, January: Design Notes. Subsample As Parameter problem. Completed
GET Model Metadata
- GET model list
- GET model list including text (description and notes)
- GET model definition metadata
- GET model metadata including text (description and notes)
- GET model metadata including text in all languages
GET Model Extras
GET Model Run results metadata
- GET list of model runs
- GET list of model runs including text (description and notes)
- GET status of model run
- GET status of model run list
- GET status of first model run
- GET status of last model run
- GET status of last completed model run
- GET model run metadata and status
- GET model run including text (description and notes)
- GET model run including text in all languages
GET Model Workset metadata: set of input parameters
- GET list of model worksets
- GET list of model worksets including text (description and notes)
- GET workset status
- GET model default workset status
- GET workset including text (description and notes)
- GET workset including text in all languages
Read Parameters, Output Tables or Microdata values
- Read parameter values from workset
- Read parameter values from workset (enum id's)
- Read parameter values from model run
- Read parameter values from model run (enum id's)
- Read output table values from model run
- Read output table values from model run (enum id's)
- Read output table calculated values from model run
- Read output table calculated values from model run (enum id's)
- Read output table values and compare model runs
- Read output table values and compare model runs (enun id's)
- Read microdata values from model run
- Read microdata values from model run (enum id's)
- Read aggregated microdata from model run
- Read aggregated microdata from model run (enum id's)
- Read microdata run comparison
- Read microdata run comparison (enum id's)
GET Parameters, Output Tables or Microdata values
- GET parameter values from workset
- GET parameter values from model run
- GET output table expression(s) from model run
- GET output table calculated expression(s) from model run
- GET output table values and compare model runs
- GET output table accumulator(s) from model run
- GET output table all accumulators from model run
- GET microdata values from model run
- GET aggregated microdata from model run
- GET microdata run comparison
GET Parameters, Output Tables or Microdata as CSV
- GET csv parameter values from workset
- GET csv parameter values from workset (enum id's)
- GET csv parameter values from model run
- GET csv parameter values from model run (enum id's)
- GET csv output table expressions from model run
- GET csv output table expressions from model run (enum id's)
- GET csv output table accumulators from model run
- GET csv output table accumulators from model run (enum id's)
- GET csv output table all accumulators from model run
- GET csv output table all accumulators from model run (enum id's)
- GET csv calculated table expressions from model run
- GET csv calculated table expressions from model run (enum id's)
- GET csv model runs comparison table expressions
- GET csv model runs comparison table expressions (enum id's)
- GET csv microdata values from model run
- GET csv microdata values from model run (enum id's)
- GET csv aggregated microdata from model run
- GET csv aggregated microdata from model run (enum id's)
- GET csv microdata run comparison
- GET csv microdata run comparison (enum id's)
GET Modeling Task metadata and task run history
- GET list of modeling tasks
- GET list of modeling tasks including text (description and notes)
- GET modeling task input worksets
- GET modeling task run history
- GET status of modeling task run
- GET status of modeling task run list
- GET status of modeling task first run
- GET status of modeling task last run
- GET status of modeling task last completed run
- GET modeling task including text (description and notes)
- GET modeling task text in all languages
Update Model Profile: set of key-value options
- PATCH create or replace profile
- DELETE profile
- POST create or replace profile option
- DELETE profile option
Update Model Workset: set of input parameters
- POST update workset read-only status
- PUT create new workset
- PUT create or replace workset
- PATCH create or merge workset
- DELETE workset
- POST delete multiple worksets
- DELETE parameter from workset
- PATCH update workset parameter values
- PATCH update workset parameter values (enum id's)
- PATCH update workset parameter(s) value notes
- PUT copy parameter from model run into workset
- PATCH merge parameter from model run into workset
- PUT copy parameter from workset to another
- PATCH merge parameter from workset to another
Update Model Runs
- PATCH update model run text (description and notes)
- DELETE model run
- POST delete model runs
- PATCH update run parameter(s) value notes
Update Modeling Tasks
Run Models: run models and monitor progress
Download model, model run results or input parameters
- GET download log file
- GET model download log files
- GET all download log files
- GET download files tree
- POST initiate entire model download
- POST initiate model run download
- POST initiate model workset download
- DELETE download files
- DELETE all download files
Upload model runs or worksets (input scenarios)
- GET upload log file
- GET all upload log files for the model
- GET all upload log files
- GET upload files tree
- POST initiate model run upload
- POST initiate workset upload
- DELETE upload files
- DELETE all upload files
Download and upload user files
- GET user files tree
- POST upload to user files
- PUT create user files folder
- DELETE file or folder from user files
- DELETE all user files
User: manage user settings
Model run jobs and service state
- GET service configuration
- GET job service state
- GET disk usage state
- POST refresh disk space usage info
- GET state of active model run job
- GET state of model run job from queue
- GET state of model run job from history
- PUT model run job into other queue position
- DELETE state of model run job from history
Administrative: manage web-service state
- POST a request to refresh models catalog
- POST a request to close models catalog
- POST a request to close model database
- POST a request to delete the model
- POST a request to open database file
- POST a request to cleanup database file
- GET the list of database cleanup log(s)
- GET database cleanup log file(s)
- POST a request to pause model run queue
- POST a request to pause all model runs queue
- PUT a request to shutdown web-service