-
Notifications
You must be signed in to change notification settings - Fork 0
Model Resource Use
Home > Model Development Topics > Model Resource Use
This topic describes now to activate and interpret information about model run-time resource use.
- Introduction and Background
- Syntax and Use How to activate and use
- Illustrated Reference Illustrated reference of each report use table
- Appendix The complete report used in the illustrations (over 500 lines)
OpenM++ models can be demanding applications for processing and memory use. The resource_use option collects and reports information which model developers can use to help identify where resource use is high. The reports can also sometimes identify model anomalies through unusually high (or low) resource use. For example, a model developer can use the reports to identify an event which is expected to occur but never does, or an an event with an anomalously high event frequency per entity.
The following subsections provide background on entities, multilinks, entity tables, sets, and events which may be helpful in understanding resource use reports.
An entity of a given type such as a Person in the RiskPaths model consists of a block of memory which holds the values of attributes and other data members. Each type of entity has a fixed size. For efficincy, entities which leave the simulation are placed in a pool for potential reuse. As a result, the number of activated entities (entities which enter the simulation) can be larger than the number of allocated entities (entity objects consuming memory).
A multilink is an attribute of an entity, but the linked entities in that multilink are stored outside the entity. The number of entities in a multilink is variable. The current value of an operation on a multilink (such as sum_over) is held in an attribute of the entity.
The cells of an entity table are in memory outside of entities. Each cell contains accumulators to which entity increments are pushed during the simulation. Each entity contains an Increment member for each table which manages the entity's current contribution to the table. Additional members in the entity may be associated with a table. Examples are an identity attribute for the table filter, the lagged value of an attribute, the value of an attribute at the start of the current table increment. An entity table can also contain, for each cell, one or more collections of microdata used to calculate ordinal statistics such as median, Gini coefficient, and percentiles.
The cells of an entity set are in memory outside of entities. Each cell of a set contains a collection of entities which satisfy the conditions to be in the cell. The entity contains a data member for the index of the entity in each set. If the entity set has a filter, the entity will contain an attribute for it.
Each event has an Event data member in the entity of the event. Pointers to these events are held in an event queue. The event queue of a time-based (interacting population) model can be large because each event of each entity is in the queue. A next occurrence time of an event is recalculated when, as a result of an event, the attributes used in the calculation of the event time change. Not all events are in the event queue. An event with next occurrence time of infinity is not in the queue, as are events whose future time is explicitly right-censored by model logic using the censor_event_time option. Maintaining the event queue can be computationally intensive and account for a significant fraction of model run time. The computational cost of event queue maintenance depends on the number of queue operations and the size of the queue.
By default, gathering and reporting of runtime information is disabled. To activate it, include the statement
options resource_use = on;in the source code of a model. A natural place to insert this statement is the module ompp_framework.ompp.
The resource use report is produced only for sub/replicate/member 0. It is written to the run log when the sub completes.
It is recommended to run with a single sub when using resource_use.
If the run has multiple subs and they run concurrently the run log file may contain interleaved lines from multiple subs, which could fragment the resource report in the run log.
The resource_use option is intended for model development, not model use. With the option on, there might be a slight reduction in run performance and a voluminous report is written to the run log.
If resource_use is enabled, the model will write a warning like the following to the log on every model run:
Warning : Model built with resource_use = on
This subtopic describes each table of the resource use report, illustrated using a run of the GMM model (Genetic Mixing Model). The illustrations include commentary to illustrate table interpretation. GMM simulates an interacting population over multiple generations, with genetic inheritance related to cancer. The GMM run for these examples used a starting population of 1 million.
This subtopic contains the following sections. Each section describes one of the tablea in the resource use report, and is illustrated with commentary using the GMM run.
- General: General information about the report
- Resource use summary: MB of memory broken out by major categories
- Entity instances: Entity counts and MB
- Entity members: Categorized counts of the data members of the entity
- Entity multilinks: Size of multilinks and MB of the entity
- Entity events: Event frequencies and presence in the event queue for the entity
- Entity sets: Sets of the entity
- Entity tables: Tables of the entity
- Entity member detail: Information on all members of the entity
- Derived tables: Size and MB of derived tables
The resource use report consists of a series of sections with one or more tables in each section. Headers in the report demarcate the sections, e.g.
************************************
* Resource Use Detail for Person *
************************************
The report starts with a summary table of memory use. This is followed by a section on resource use for each kind of entity in the model. These entity sections can contain up to 7 tables on resource use for each kind of entity.
The illustration has three kinds of entities: Person, Doppleganger, and Ticker, so the report contains three sections with up to 7 tables each.
The report concludes with a table on memory use of derived tables.
Numbers in the MB column are lower bound estimates. Actual memory use depends on implementation details of the C++ standard library and the host operating system.
Each line of the resource report has a timestamp prefix, as do all lines in run logs. These prefixes have been stripped in the examples.
For brevity, "run" below means "sub/replicate/member 0 of the run". If the run consists of a single sub as recommended above, the two are the same.
[back to illustrated reference]
[back to topic contents]
The resource use report report begins with a summary of memory use:
+---------------------------+
| Resource Use Summary |
+-------------------+-------+
| Category | MB |
+-------------------+-------+
| Entities | 1924 |
| Doppelganger | 552 |
| Person | 1372 |
| Ticker | 0 |
| Multilinks | 10 |
| Events | 80 |
| Sets | 196 |
| Tables | 0 |
+-------------------+-------+
| All | 2213 |
+-------------------+-------+
This table summarizes information found in detailed tables elsewhere in the report. The first lines report memory use for entities in the run by type of entity. Subsequent lines report memory use outside of entities.
In the example, total memory use was a bit over 2 GB. The bulk of memory use was concentrated in the Person entity. Memory use for the Doppleganger entity was nevertheless significant at around 0.5 GB. The event queue consumed only 80 MB, and the entity sets used to implement union formation took around 200 MB.
[back to illustrated reference]
[back to topic contents]
This is table 1 of 7 in the Resource Use Detail section for the entity type.
It is a one-row table about instances of the entity:
Here it is for the Person entity:
+-------------------------------------+
| Person Instances |
+--------------+--------------+-------+
| Activations | Allocations | MB |
+--------------+--------------+-------+
| 2302315 | 1003104 | 1372 |
+--------------+--------------+-------+
Activations is the number of times a Person entity entered the simulation.
Allocations is the number of times memory for a Person entity was allocated.
MB is the product of Allocations and the size in bytes of a Person entity.
Allocations differ from Activations because OpenM++ recycles an entity for reuse when it leaves the simulation.
So when a Person dies and leaves the simulation in GMM the Person is placed into a pool and recycled when a new Person is born during the simulation.
In the illustration, a bit over half of the Person entities were recycled during the run.
Here is the same table for the Doppleganger entity:
+-------------------------------------+
| Doppelganger Instances |
+--------------+--------------+-------+
| Activations | Allocations | MB |
+--------------+--------------+-------+
| 2302315 | 2302315 | 552 |
+--------------+--------------+-------+
Unlike for Person entities, the number of Allocations of Doppleganger entities is indetical to the number of Activations.
In GMM, each Person entity has an associated Doppleganger entity which duplicates several attributes of the linked Person during the simulation. The Doppleganger entity has no events or tables of its own and is considerably smaller than the Person entity. Unlike the Person entity, the Doppleganger entity persists after death. That allows the construction of a multi-generational pedigree for the desendants of each Person, even if the ancestors of the Person are no longer present in the population.
[back to illustrated reference]
[back to topic contents]
This is table 2 of 7 in the Resource Use Detail section for the entity type.
Here it is for the Person entity in the example:
+---------------------------+
| Person Members |
+-------------------+-------+
| Member | Count |
+-------------------+-------+
| Attributes | 201 |
| Built-in | 6 |
| Simple | 57 |
| Maintained | 136 |
| Link | 2 |
| Events | 11 |
| Increments | 3 |
| Multilink | 0 |
| Internal | 60 |
| Array | 0 |
| Foreign | 1 |
+-------------------+-------+
| All | 276 |
+-------------------+-------+
This table provides counts of all data members fo the entity, by category. The meaning of each category is given in the following table. Detail on each data member of the entity is reported in the Entity member detail table.
| Row | Description |
|---|---|
| Attributes | All attributes in the entity, including attributes generated by the OpenM++ compiler. |
| Built-in | Attributes such as time, age, and entity_id. |
| Simple | Attributes declared in model code with values set explicitly by model code. |
| Maintained | Automatically maintained attributes such as duration(), identity attributes, and operators on multilinks such as sum_over. |
| Link | Links to another entity declared in the model. |
| Events | Events declared in the model, and possibly the generated event om_ss_event for self-scheduling events. |
| Increments | Increments for entity tables, one for each accumulator in each entity table. |
| Multilink | Multilinks declared in model code. |
| Internal | Data members (not attributes) created by the OpenM++ compiler to implement the model. |
| Array | Arrays declared in the model code. |
| Foreign | Members with an developer-supplied type declared in model code. |
In GMM the Person entity has 276 data members.
Here's the same table for the Doppleganger entity:
+---------------------------+
| Doppelganger Members |
+-------------------+-------+
| Member | Count |
+-------------------+-------+
| Attributes | 44 |
| Built-in | 6 |
| Simple | 28 |
| Maintained | 7 |
| Link | 3 |
| Events | 0 |
| Increments | 0 |
| Multilink | 2 |
| Internal | 10 |
| Array | 0 |
| Foreign | 0 |
+-------------------+-------+
| All | 56 |
+-------------------+-------+
The Doppleganger entity has fewer members than the Person entity. This is a design goal of the model architecture. A Doppleganger entity contains minimal information echoed from its corresponding Person entity. Doppleganger entities are deliberately small because they persist after death, which increases memory use as simulation time advances.
From the table, the Doppleganger entity has 2 multilinks whereas the Person entity has none. That's because the multilinks between parent and children need to persist beyond the lifetime of the parent in order to generate multi-generational family pedigrees to assess the genetic component of cancer risk of descendants.
[back to illustrated reference]
[back to topic contents]
This is table 3 of 7 in the Resource Use Detail section for the entity type.
Here it is for the Doppelganger entity in the example:
+------------------------------------------------------------------------+
| Doppelganger Multilink elements |
+-------------------+--------------+--------------+--------------+-------+
| multilink | max size | entity_id | avg size | MB |
+-------------------+--------------+--------------+--------------+-------+
| mlFather_children | 11 | 3241001 | 0.2954 | 5 |
| mlMother_children | 7 | 2794375 | 0.2954 | 5 |
+-------------------+--------------+--------------+--------------+-------+
| All | | | | 10 |
+-------------------+--------------+--------------+--------------+-------+
The meaning of each column is given in the following table.
| Column | Description |
|---|---|
| multilink | The name of the multilink as declared in model code. |
| max size | The maximum of the multilink size over all entities in the run. |
| entity_id | An entity_id for which that maximum was attained. |
| avg size | The average over all entities of the maximum per-entity multilink size. |
When resource_use is turned on, the maximum multilink size is tracked and the associated entity_id recorded and reported in this table to help model developers probe extreme cases or anomalies.
In the example, the maximum number of children of fathers was 11, which occurred for entity_id 3241001. The maximum number of children of mothers was 7. This assymetry is an expected consequence of the model design, which acounts for pregnancy, reduced fertility after childbirth, age- and sex-specific union formation and dissolution patterns, and patterns of completed fertility for females.
At first glance the average size of the parent-children multilinks seems small at 0.2954, which is well below replacement fertility. This is an expected consequence of the model architecture, for several reasons. First, the starting population of Person entities is cross-sectional and those entities have no children. Second, fertility is exogenous during the model's burn-in period when coherent patterns of union formation, union duration, and family structure are being established. Third, all entities exit the run when it ends at year 200, and for many that will occur before lifetime fertility is complete.
[back to illustrated reference]
[back to topic contents]
This is table 4 of 7 in the Resource Use Detail section for the entity type.
Here it is for the Person entity in the illustrative GMM run:
+----------------------------------------------------------------------------------------------------------+
| Person Events |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
| event | time calcs | censored | occurrences | per entity | max in queue | MB |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
| CancerBreastEvent | 142141567 | 132678956 | 109264 | 0.0475 | 98068 | 3 |
| CancerOvaryEvent | 142046175 | 140468459 | 13872 | 0.0060 | 16588 | 0 |
| CancerPancreasEvent | 142059175 | 138987528 | 26872 | 0.0117 | 31477 | 1 |
| CancerProstateEvent | 142183730 | 129790585 | 151427 | 0.0658 | 120050 | 3 |
| ConceptionEvent | 66577109 | 48877013 | 1081390 | 0.4697 | 110508 | 3 |
| MortalityEvent | 142032303 | 91704028 | 2074535 | 0.9011 | 396686 | 12 |
| PregnancyClockEvent | 6624484 | 3383265 | 3240779 | 1.4076 | 8603 | 0 |
| SexualDebutEvent | 143503691 | 132811541 | 1471388 | 0.6391 | 87064 | 2 |
| UnionDissolutionEvent | 187014898 | 144258340 | 10000504 | 4.3437 | 257025 | 8 |
| UnionFormationEvent | 76657431 | 63401111 | 11722623 | 5.0917 | 389374 | 12 |
| om_ss_event | 431081130 | 457311 | 288052240 | 125.1142 | 1003104 | 32 |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
| All | | | | | | 80 |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
The meaning of each column is given in the following table.
| Column | Description |
|---|---|
| event | The name of the event as given in model code. The event om_ss_event, if present, is a generated event which implements all self-scheduling attributes in the entity. |
| time calcs | The number of calculations of time-of-next occurrence of the event. |
| censored | The number of such calculations which were censored and not inserted into the event queue. Events can be censored either because their next occurrence time is infinity, or by explicit model code in conjunction with the censor_event_time option. |
| occurrences | The number of occurrences of the event during the run. |
| per entity | The average number of occurrences per entity, calculated as the number of event occurrences divided by the number of activations of the entity type during the run. |
| max in queue | The maximum count of this event in the event queue during the run. |
| MB | The number of MB required to store that maximum count in the event queue, calculated as the product of the maximum count and the size in bytes of a queue element. |
In the illustrative GMM run, the average number of union formations is somewhat larger than the number of union dissolutions, which is expected. The frequency of cancer events is as expected, taking into account that the denominator in the table is all Person entities (both male and female). The average number of self-scheduling events is high, due to the attribute self_scheduling_int(age), which is listed in Entity member detail for Person in the resource use report.
[back to illustrated reference]
[back to topic contents]
This is table 5 of 7 in the Resource Use Detail section for the entity type.
Here it is for the Person entity in the example:
+---------------------------------------------------------------------------------+
| Person Sets |
+-----------------+-------+----------+----------+--------------+----------+-------+
| set | rank | cells | inserts | per entity | max pop | MB |
+-----------------+-------+----------+----------+--------------+----------+-------+
| asAllPerson | 0 | 1 | 2302315 | 1.0000 | 1003104 | 48 |
| asAvailableMen | 2 | 48 | 14336309 | 6.2269 | 396653 | 19 |
| asAvailableMenV | 3 | 96 | 15484605 | 6.7257 | 396653 | 19 |
+-----------------+-------+----------+----------+--------------+----------+-------+
| All | | | | | | 86 |
+-----------------+-------+----------+----------+--------------+----------+-------+
The meaning of each column is given in the following table.
| Column | Description |
|---|---|
| set | The name of the entity set as given in model code. |
| rank | The number of dimensions in the entity set. |
| cells | The number of cells in the entity set, calculated as the product of the dimension sizes. |
| inserts | The number of insert operations on the set during the run, which counts entrances into the set and movements from cell to cell within the set. |
| per entity | The number of inserts per entity, calculated as the number of inserts divided by the number of activations of the entity type during the run. |
| max pop | The maximum count of entities in the set during the run. |
| MB | The number of MB required to store that maximum count in the entity set, calculated as the product of the maximum count and the size in bytes of a set element. |
In the example, the set asAllPerson has a single cell and contains all Person entities. This set is used to communicate the passage of integer time (year) from the single Ticker entity to all Person entities during the run. The maximum population in this set is slightly higher than the starting population of 1 million, perhaps due to Monte Carlo variation during the burn-in phase of the run.
The other two entity sets help implement a female choice model of union formation. The churning in these sets is a consequence of changes in union status ('single' is a filter condition of these sets) and age group (a dimension of these sets).
[back to illustrated reference]
[back to topic contents]
This is table 6 of 7 in the Resource Use Detail section for the entity type.
Here it is for the Person entity in the
+--------------------------------------------------------------------------------------------------------------------+
| Person Tables |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| table | rank | cells | accum | measr | colls | incrmnts | per entity | MB |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| Boadicea_RR_cross | 2 | 256 | 3 | 3 | 0 | 154304 | 0.0670 | 0 |
| IM_RiskEvaluationDistributionDetailed | 2 | 150 | 1 | 1 | 0 | 154304 | 0.0670 | 0 |
| PersonEvents | 2 | 2222 | 1 | 1 | 0 | 168607252 | 73.2338 | 0 |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| All | | | | | | | | 0 |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
Tables suppressed at run-time are not included in this report. If there are any such, a message with the number of run-time suppressed tables follows immediately after the table.
The meaning of each column is given in the following table.
| Column | Description |
|---|---|
| table | The name of the entity table as given in model code. |
| rank | The number of dimensions in the table. |
| cells | The number of cells in the table, calculated as the product of the dimension sizes, including margins if present. |
| accum | The number of accumulators in the table. |
| measr | The number of measures in the table. |
| colls | The number of collections in the table. |
| incrmnts | The number of increments pushed to the table during the run. |
| per entity | The number of increments per entity, calculated as the number of increments divided by the number of activations of the entity type during the run. |
| MB | The number of MB required by the cells of the table, calculated as the product of the number of cells, the number of accumulators, and the size in bytes of a double. |
GMM contains many tables, but most are suppressed in the production variant of the model using tables_retain statements. The PersonEvents table was retained, but given the high volume of increments shown in the table above (168m) and its diagnostic nature it is a candidate for suppression in the production variant of GMM.
[back to illustrated reference]
[back to topic contents]
This is table 7 of 7 in the Resource Use Detail section for the entity type.
This table contains one row for each entity member, and so can have many rows.
Here is an extract of selected rows for the Person entity for the GMM example.
+------------------------------------------------+-------+
| Person Members (detail) |
+------------------------------------------------+-------+
| member | bytes |
+------------------------------------------------+-------+
| Attributes: | |
| Built-in: | |
| age | 8 |
| entity_id | 4 |
| time | 8 |
| Simple: | |
| alive | 1 |
| union_status | 1 |
| year | 1 |
| Maintained: | |
| age_group | 1 |
| can_conceive | 1 |
...
| Array: | |
| Foreign: | |
| breast_cancer_hazard | 24 |
+------------------------------------------------+-------+
| Sum of member bytes | 1218 |
| Bytes per entity | 1368 |
| Storage efficiency (%) | 89.0 |
+------------------------------------------------+-------+
The rows of this table are grouped like the Entity members table. It contains one row for each member with the the member name (or an identifying string) followed by its size in bytes.
There are three summary rows at the end: the sum of member bytes, the actual size of the entity in bytes, and the implied storage efficiency. For more on member packing and storage efficiency see Entity Member Packing.
For GMM, this table has almmost 300 rows. For the full version see Appendix.
The following table extracts selected rows from the full table, and adds annotations.
| member | bytes | remarks |
|---|---|---|
| Attributes | ||
| Built-in | ||
| age | 8 |
case_seed | 8 |
censor_time | 8 | Created by the compiler if the `censor_event_time` option is activated
entity_id | 4 |
events | 2 |
time | 8 |
Simple | |
alive | 1 | Declared in model as type bool. Note a bool takes one byte of storage, not one bit.
union_status | 1 |
year | 1 | Declared in model. The value is maintained by the Ticker actor which updates the value for all Person entities by iterating the asAllPersons entity set.
Maintained | |
can_conceive | 1 | An identity attribute declared in model code. identity attribute.
om_aia_0 | 1 | An identity attribute created by the compiler to implement other attributes.
om_asAvailableMen_filter | 1 | An identity attribute created by the compiler to implement the filter of the entity set asAvailableMen.
duration() | 8 | A maintained attribute created by the compiler
entrances(union_status,US_SINGLE) | 2 |
self_scheduling_int(age) | 2 |
trigger_changes(year) | 1 |
Link | |
lDoppelganger | 8 |
lPartner | 8 |
Events | |
ConceptionEvent | 24 |
MortalityEvent | 24 |
om_ss_event | 24 |
Increments | |
Boadicea_RR_cross increment | 32 |
PersonEvents increment | 32 |
Multilink | |
Internal | |
PersonEvents (inevent) event_count | 4 |
asAvailableMen (current cell) | 4 |
event_count (lagged) | 4 |
event_count (counter at lagged) | 8 |
om_self_scheduling_int_FOR_age (scheduled time) | 8 | | 8 |
Array | |
Foreign | |
breast_cancer_hazard | 24 |
[back to illustrated reference]
[back to topic contents]
Here's an example of the Derived Tables resource use table.
Verbiage.
[back to illustrated reference]
[back to topic contents]
For reference, here is the complete report of the GMM run used in the illustrations.
Resource Use Report - Begin (for sub/member/replicate 0)
**************************
* Resource Use Summary *
**************************
+---------------------------+
| Resource Use Summary |
+-------------------+-------+
| Category | MB |
+-------------------+-------+
| Entities | 1924 |
| Doppelganger | 552 |
| Person | 1372 |
| Ticker | 0 |
| Multilinks | 10 |
| Events | 80 |
| Sets | 196 |
| Tables | 0 |
+-------------------+-------+
| All | 2213 |
+-------------------+-------+
******************************************
* Resource Use Detail for Doppelganger *
******************************************
+-------------------------------------+
| Doppelganger Instances |
+--------------+--------------+-------+
| Activations | Allocations | MB |
+--------------+--------------+-------+
| 2302315 | 2302315 | 552 |
+--------------+--------------+-------+
Note: MB does not include storage of elements of multilinks
+---------------------------+
| Doppelganger Members |
+-------------------+-------+
| Member | Count |
+-------------------+-------+
| Attributes | 44 |
| Built-in | 6 |
| Simple | 28 |
| Maintained | 7 |
| Link | 3 |
| Events | 0 |
| Increments | 0 |
| Multilink | 2 |
| Internal | 10 |
| Array | 0 |
| Foreign | 0 |
+-------------------+-------+
| All | 56 |
+-------------------+-------+
+------------------------------------------------------------------------+
| Doppelganger Multilink elements |
+-------------------+--------------+--------------+--------------+-------+
| multilink | max size | entity_id | avg size | MB |
+-------------------+--------------+--------------+--------------+-------+
| mlFather_children | 11 | 3241001 | 0.2954 | 5 |
| mlMother_children | 7 | 2794375 | 0.2954 | 5 |
+-------------------+--------------+--------------+--------------+-------+
| All | | | | 10 |
+-------------------+--------------+--------------+--------------+-------+
Note: MB does not include entity members
+-----------------------------------------------------------------------------------+
| Doppelganger Sets |
+-------------------+-------+----------+----------+--------------+----------+-------+
| set | rank | cells | inserts | per entity | max pop | MB |
+-------------------+-------+----------+----------+--------------+----------+-------+
| asAllDoppelganger | 0 | 1 | 2302315 | 1.0000 | 2302315 | 110 |
+-------------------+-------+----------+----------+--------------+----------+-------+
| All | | | | | | 110 |
+-------------------+-------+----------+----------+--------------+----------+-------+
Note: MB does not include entity members
+------------------------------------------------+
| Doppelganger Members (detail) |
+----------------------------------------+-------+
| member | bytes |
+----------------------------------------+-------+
| Attributes: | |
| Built-in: | |
| age | 8 |
| case_seed | 8 |
| censor_time | 8 |
| entity_id | 4 |
| events | 2 |
| time | 8 |
| Simple: | |
| boadicea_risk_factor_code | 4 |
| children | 4 |
| endogenous_grandparent_count | 1 |
| enhanced_screening_reason | 1 |
| g1_atm_mutation | 1 |
| g1_brca1_mutation | 1 |
| g1_brca2_mutation | 1 |
| g1_chek2_mutation | 1 |
| g1_palb2_mutation | 1 |
| g2_atm_mutation | 1 |
| g2_brca1_mutation | 1 |
| g2_brca2_mutation | 1 |
| g2_chek2_mutation | 1 |
| g2_palb2_mutation | 1 |
| grandparent_count | 1 |
| major_genotype | 1 |
| one_column | 1 |
| polygene_bin | 1 |
| polygenic_known | 4 |
| polygenic_unknown | 4 |
| sex | 1 |
| year_born | 2 |
| year_cancer_breast | 2 |
| year_cancer_ovary | 2 |
| year_cancer_pancreas | 2 |
| year_cancer_prostate | 2 |
| year_died | 2 |
| year_start_enhanced_screening | 2 |
| Maintained: | |
| any_mutation | 1 |
| atm_mutation | 1 |
| brca1_mutation | 1 |
| brca2_mutation | 1 |
| chek2_mutation | 1 |
| palb2_mutation | 1 |
| polygenic_total | 4 |
| Link: | |
| lFather | 8 |
| lMother | 8 |
| lPerson | 8 |
| Events: | |
| Increments: | |
| Multilink: | |
| mlFather_children | 24 |
| mlMother_children | 24 |
| Internal: | |
| MajorGenotype1 (in) any_mutation | 1 |
| MajorGenotype1 (in) atm_mutation | 1 |
| MajorGenotype1 (in) brca1_mutation | 1 |
| MajorGenotype1 (in) brca2_mutation | 1 |
| MajorGenotype1 (in) chek2_mutation | 1 |
| MajorGenotype1 (in) palb2_mutation | 1 |
| Polygene1 (in) polygenic_known | 4 |
| Polygene1 (in) polygenic_total | 4 |
| Polygene1 (in) polygenic_unknown | 4 |
| asAllDoppelganger (current cell) | 4 |
| Array: | |
| Foreign: | |
+----------------------------------------+-------+
| Sum of member bytes | 189 |
| Bytes per entity | 240 |
| Storage efficiency (%) | 78.8 |
+----------------------------------------+-------+
************************************
* Resource Use Detail for Person *
************************************
+-------------------------------------+
| Person Instances |
+--------------+--------------+-------+
| Activations | Allocations | MB |
+--------------+--------------+-------+
| 2302315 | 1003104 | 1372 |
+--------------+--------------+-------+
Note: MB does not include storage of elements of foreign objects
+---------------------------+
| Person Members |
+-------------------+-------+
| Member | Count |
+-------------------+-------+
| Attributes | 201 |
| Built-in | 6 |
| Simple | 57 |
| Maintained | 136 |
| Link | 2 |
| Events | 11 |
| Increments | 3 |
| Multilink | 0 |
| Internal | 60 |
| Array | 0 |
| Foreign | 1 |
+-------------------+-------+
| All | 276 |
+-------------------+-------+
+----------------------------------------------------------------------------------------------------------+
| Person Events |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
| event | time calcs | censored | occurrences | per entity | max in queue | MB |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
| CancerBreastEvent | 142141567 | 132678956 | 109264 | 0.0475 | 98068 | 3 |
| CancerOvaryEvent | 142046175 | 140468459 | 13872 | 0.0060 | 16588 | 0 |
| CancerPancreasEvent | 142059175 | 138987528 | 26872 | 0.0117 | 31477 | 1 |
| CancerProstateEvent | 142183730 | 129790585 | 151427 | 0.0658 | 120050 | 3 |
| ConceptionEvent | 66577109 | 48877013 | 1081390 | 0.4697 | 110508 | 3 |
| MortalityEvent | 142032303 | 91704028 | 2074535 | 0.9011 | 396686 | 12 |
| PregnancyClockEvent | 6624484 | 3383265 | 3240779 | 1.4076 | 8603 | 0 |
| SexualDebutEvent | 143503691 | 132811541 | 1471388 | 0.6391 | 87064 | 2 |
| UnionDissolutionEvent | 187014898 | 144258340 | 10000504 | 4.3437 | 257025 | 8 |
| UnionFormationEvent | 76657431 | 63401111 | 11722623 | 5.0917 | 389374 | 12 |
| om_ss_event | 431081130 | 457311 | 288052240 | 125.1142 | 1003104 | 32 |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
| All | | | | | | 80 |
+-----------------------+--------------+--------------+--------------+--------------+--------------+-------+
Note: MB does not include entity members
+---------------------------------------------------------------------------------+
| Person Sets |
+-----------------+-------+----------+----------+--------------+----------+-------+
| set | rank | cells | inserts | per entity | max pop | MB |
+-----------------+-------+----------+----------+--------------+----------+-------+
| asAllPerson | 0 | 1 | 2302315 | 1.0000 | 1003104 | 48 |
| asAvailableMen | 2 | 48 | 14336309 | 6.2269 | 396653 | 19 |
| asAvailableMenV | 3 | 96 | 15484605 | 6.7257 | 396653 | 19 |
+-----------------+-------+----------+----------+--------------+----------+-------+
| All | | | | | | 86 |
+-----------------+-------+----------+----------+--------------+----------+-------+
Note: MB does not include entity members
+--------------------------------------------------------------------------------------------------------------------+
| Person Tables |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| table | rank | cells | accum | measr | colls | incrmnts | per entity | MB |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| Boadicea_RR_cross | 2 | 256 | 3 | 3 | 0 | 154304 | 0.0670 | 0 |
| IM_RiskEvaluationDistributionDetailed | 2 | 150 | 1 | 1 | 0 | 154304 | 0.0670 | 0 |
| PersonEvents | 2 | 2222 | 1 | 1 | 0 | 168607252 | 73.2338 | 0 |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| All | | | | | | | | 0 |
+---------------------------------------+-------+----------+-------+-------+-------+----------+--------------+-------+
Note: MB does not include entity members
+------------------------------------------------------------------------------------------+
| Person Members (detail) |
+----------------------------------------------------------------------------------+-------+
| member | bytes |
+----------------------------------------------------------------------------------+-------+
| Attributes: | |
| Built-in: | |
| age | 8 |
| case_seed | 8 |
| censor_time | 8 |
| entity_id | 4 |
| events | 2 |
| time | 8 |
| Simple: | |
| PRS_top_5 | 1 |
| activity_level | 1 |
| actual_RR | 8 |
| actual_risk | 8 |
| alive | 1 |
| base_risk | 8 |
| boadicea_CPU | 8 |
| boadicea_RR | 8 |
| boadicea_evaluations | 4 |
| boadicea_risk | 8 |
| cancer_breast | 1 |
| cancer_ovary | 1 |
| cancer_pancreas | 1 |
| cancer_prostate | 1 |
| children_born | 4 |
| eligible_union | 1 |
| endogenous_grandparent_count | 1 |
| endogenous_parent_count | 1 |
| enhanced_screening | 1 |
| enhanced_screening_reason | 1 |
| entry_year | 1 |
| event_count | 4 |
| event_type | 1 |
| generation | 1 |
| grandparent_count | 1 |
| has_any_mutation | 1 |
| in_union_ey | 1 |
| in_union_ybey | 1 |
| is_in_starting_population | 1 |
| major_genotype | 1 |
| match_failures_forbidden | 4 |
| match_failures_none | 4 |
| match_successes | 4 |
| mother_cancer | 1 |
| one_column | 1 |
| parent_count | 1 |
| polygene_bin | 1 |
| post_partum | 1 |
| pregnant | 1 |
| ps | 1 |
| risk_assessments | 4 |
| risk_factor_alcohol | 1 |
| risk_factor_bmi | 1 |
| risk_factor_first_b | 1 |
| risk_factor_mammo_density | 1 |
| risk_factor_menarche | 1 |
| risk_factor_menopause | 1 |
| risk_factor_mht | 1 |
| risk_factor_oc | 1 |
| risk_factor_parity | 1 |
| sex | 1 |
| simulate_risk_factors | 1 |
| time_pregnancy_clock | 8 |
| twin_pregnancy | 1 |
| undergone_debut | 1 |
| union_status | 1 |
| year | 1 |
| Maintained: | |
| age_group | 1 |
| age_group1 | 1 |
| age_group_15 | 1 |
| age_group_for_debut | 4 |
| ar_er | 8 |
| boadicea_horizon | 4 |
| can_conceive | 1 |
| children0 | 1 |
| children1 | 1 |
| children2 | 1 |
| children3 | 1 |
| children4 | 1 |
| children4plus | 1 |
| children5 | 1 |
| children6 | 1 |
| children7 | 1 |
| children8plus | 1 |
| delta_partners_ybey | 4 |
| diff_RR | 8 |
| diff_RR_abs | 8 |
| dissolutions | 4 |
| ever_had_sex | 1 |
| fertile | 1 |
| fertile_age | 1 |
| genotype_group | 1 |
| in_casual_union | 1 |
| in_scope_fertility | 1 |
| in_stable_union | 1 |
| in_union | 1 |
| in_utero | 1 |
| incidenceRR50 | 8 |
| incidence_rr | 8 |
| integer_age | 4 |
| is_ey | 1 |
| multiple_fathers | 1 |
| my_year | 1 |
| active_spell_delta(year_spell,true,partners) | 2 |
| om_aia_0 | 1 |
| om_aia_1 | 1 |
| om_aia_10 | 1 |
| om_aia_11 | 1 |
| om_aia_12 | 1 |
| om_aia_13 | 1 |
| om_aia_14 | 1 |
| om_aia_15 | 1 |
| om_aia_16 | 1 |
| om_aia_17 | 1 |
| om_aia_18 | 1 |
| om_aia_19 | 1 |
| om_aia_2 | 1 |
| om_aia_20 | 1 |
| om_aia_21 | 1 |
| om_aia_22 | 1 |
| om_aia_23 | 1 |
| om_aia_24 | 1 |
| om_aia_25 | 1 |
| om_aia_26 | 1 |
| om_aia_27 | 1 |
| om_aia_28 | 1 |
| om_aia_29 | 4 |
| om_aia_3 | 1 |
| om_aia_30 | 1 |
| om_aia_31 | 1 |
| om_aia_32 | 1 |
| om_aia_4 | 1 |
| om_aia_5 | 1 |
| om_aia_6 | 1 |
| om_aia_7 | 1 |
| om_aia_8 | 1 |
| om_aia_9 | 1 |
| om_asAvailableMenV_filter | 1 |
| om_asAvailableMen_filter | 1 |
| completed_spell_delta(year_spell,true,partners) | 2 |
| duration() | 8 |
| duration(activity_level,AL_0) | 8 |
| duration(activity_level,AL_1) | 8 |
| duration(activity_level,AL_2) | 8 |
| duration(activity_level,AL_3) | 8 |
| duration(boadicea_evaluations,1) | 8 |
| duration(can_conceive,true) | 8 |
| duration(cancer_breast,true) | 8 |
| duration(enhanced_screening,true) | 8 |
| duration(undergone_debut,true) | 8 |
| entrances(cancer_breast,true) | 2 |
| entrances(cancer_ovary,true) | 2 |
| entrances(cancer_pancreas,true) | 2 |
| entrances(cancer_prostate,true) | 2 |
| entrances(in_stable_union,true) | 2 |
| entrances(union_status,US_CASUAL) | 2 |
| entrances(union_status,US_SINGLE) | 2 |
| entrances(union_status,US_STABLE) | 2 |
| self_scheduling_int(age) | 2 |
| self_scheduling_int(duration(boadicea_evaluations,1)) | 2 |
| split(activity_level,ACTIVITY_3) | 1 |
| split(actual_RR,PARTITION_RR) | 1 |
| split(boadicea_RR,IM_PARTITION_RR) | 1 |
| split(boadicea_RR,PARTITION_RR) | 1 |
| split(diff_RR,DIFF_RR) | 1 |
| split(integer_age,AGE_GROUP15_1549) | 1 |
| split(integer_age,AGE_GROUP5_1549) | 1 |
| split(integer_age,AGE_GROUP5_1559) | 1 |
| split(integer_age,GROUPE_AGE2_1070) | 1 |
| split(integer_age,P_AGE_FOR_SEXUAL_DEBUT) | 1 |
| split(partners_ybey,PARTNERS_5) | 1 |
| trigger_changes(boadicea_evaluations) | 1 |
| trigger_changes(cancer_breast) | 1 |
| trigger_changes(year) | 1 |
| trigger_entrances(boadicea_evaluations,1) | 1 |
| trigger_entrances(integer_age,0) | 1 |
| trigger_exits(children_born,0) | 1 |
| trigger_exits(children_born,1) | 1 |
| trigger_exits(integer_age,39) | 1 |
| undergone_change(partners) | 1 |
| undergone_change(union_status) | 1 |
| undergone_entrance(pregnant,true) | 1 |
| undergone_entrance(risk_assessments,1) | 1 |
| value_at_first_entrance(pregnant,true,union_number) | 4 |
| value_at_first_entrance(risk_assessments,1,cancer_breast) | 1 |
| value_at_latest_entrance(om_aia_17,true,partners) | 4 |
| value_at_latest_entrance(pregnant,true,union_number) | 4 |
| parity | 1 |
| partners | 4 |
| partners_casual | 4 |
| partners_stable | 4 |
| partners_ybey | 4 |
| polygenic_total | 4 |
| possible_proband | 1 |
| range_age | 1 |
| range_age_80 | 1 |
| stable_union | 1 |
| union_number | 4 |
| union_number_at_first_conception | 4 |
| union_number_at_latest_conception | 4 |
| virgin | 1 |
| year_flash | 1 |
| year_spell | 1 |
| Link: | |
| lDoppelganger | 8 |
| lPartner | 8 |
| Events: | |
| CancerBreastEvent | 24 |
| CancerOvaryEvent | 24 |
| CancerPancreasEvent | 24 |
| CancerProstateEvent | 24 |
| ConceptionEvent | 24 |
| MortalityEvent | 24 |
| PregnancyClockEvent | 24 |
| SexualDebutEvent | 24 |
| UnionDissolutionEvent | 24 |
| UnionFormationEvent | 24 |
| om_ss_event | 24 |
| Increments: | |
| Boadicea_RR_cross increment | 32 |
| IM_RiskEvaluationDistributionDetailed increment | 32 |
| PersonEvents increment | 32 |
| Multilink: | |
| Internal: | |
| ALT_ActivityLevel (in) om_duration | 8 |
| ALT_ActivityLevel (in) om_duration_FOR_activity_level_X_AL_0 | 8 |
| ALT_ActivityLevel (in) om_duration_FOR_activity_level_X_AL_1 | 8 |
| ALT_ActivityLevel (in) om_duration_FOR_activity_level_X_AL_2 | 8 |
| ALT_ActivityLevel (in) om_duration_FOR_activity_level_X_AL_3 | 8 |
| BirthRate (in) children_born | 4 |
| BirthRate (in) om_duration | 8 |
| BreastCancerRates (in) om_duration | 8 |
| BreastCancerRates (in) om_duration_FOR_cancer_breast_X_true | 8 |
| BreastCancerRates (in) om_entrances_FOR_cancer_breast_X_true | 2 |
| CanConceive (in) om_duration | 8 |
| CanConceive (in) om_duration_FOR_can_conceive_X_true | 8 |
| CancerRates (in) om_duration | 8 |
| CancerRates (in) om_duration_FOR_cancer_breast_X_true | 8 |
| CancerRates (in) om_entrances_FOR_cancer_breast_X_true | 2 |
| CancerRates (in) om_entrances_FOR_cancer_ovary_X_true | 2 |
| CancerRates (in) om_entrances_FOR_cancer_pancreas_X_true | 2 |
| CancerRates (in) om_entrances_FOR_cancer_prostate_X_true | 2 |
| FertilityByAge (in) children_born | 4 |
| FertilityByAge (in) om_duration | 8 |
| InUtero (in) om_duration | 8 |
| MatchReport (in) match_failures_forbidden | 4 |
| MatchReport (in) match_failures_none | 4 |
| MatchReport (in) match_successes | 4 |
| PYAgeZero (in) om_duration | 8 |
| PersonEvents (inevent) event_count | 4 |
| Polygene1a (in) polygenic_total | 4 |
| PopulationByYear (in) om_duration | 8 |
| SDT_SexualDebut (in) om_duration | 8 |
| SDT_SexualDebut (in) om_duration_FOR_undergone_debut_X_true | 8 |
| Screening1 (in) om_duration | 8 |
| Screening1 (in) om_duration_FOR_enhanced_screening_X_true | 8 |
| Screening1 (in) risk_assessments | 4 |
| Screening2 (in) cancer_breast | 1 |
| Screening2 (in) om_duration | 8 |
| Screening3 (in) cancer_breast | 1 |
| Screening3 (in) om_duration | 8 |
| Screening4 (in) cancer_breast | 1 |
| Screening5 (in) cancer_breast | 1 |
| SimulatedEverHadSex (in) ever_had_sex | 1 |
| SimulatedProportionStable (in) in_stable_union | 1 |
| X4_Observed_RR (in) cancer_breast | 1 |
| X4_Observed_RR (in) om_duration | 8 |
| X5_Difference_RR (in) diff_RR_abs | 8 |
| X5_Difference_RR (in) entity_id | 4 |
| asAllPerson (current cell) | 4 |
| asAvailableMenV (current cell) | 4 |
| asAvailableMen (current cell) | 4 |
| event_count (lagged) | 4 |
| event_count (counter at lagged) | 8 |
| om_self_scheduling_int_FOR_age (scheduled time) | 8 |
| om_self_scheduling_int_FOR_om_duration_FOR_boadicea_evaluations_X_1 (scheduled time) | 8 |
| om_trigger_changes_FOR_boadicea_evaluations (scheduled time) | 8 |
| om_trigger_changes_FOR_cancer_breast (scheduled time) | 8 |
| om_trigger_changes_FOR_year (scheduled time) | 8 |
| om_trigger_entrances_FOR_boadicea_evaluations_X_1 (scheduled time) | 8 |
| om_trigger_entrances_FOR_integer_age_X_0 (scheduled time) | 8 |
| om_trigger_exits_FOR_children_born_X_0 (scheduled time) | 8 |
| om_trigger_exits_FOR_children_born_X_1 (scheduled time) | 8 |
| om_trigger_exits_FOR_integer_age_X_39 (scheduled time) | 8 |
| Array: | |
| Foreign: | |
| breast_cancer_hazard | 24 |
+----------------------------------------------------------------------------------+-------+
| Sum of member bytes | 1218 |
| Bytes per entity | 1368 |
| Storage efficiency (%) | 89.0 |
+----------------------------------------------------------------------------------+-------+
************************************
* Resource Use Detail for Ticker *
************************************
+-------------------------------------+
| Ticker Instances |
+--------------+--------------+-------+
| Activations | Allocations | MB |
+--------------+--------------+-------+
| 1 | 1 | 0 |
+--------------+--------------+-------+
+---------------------------+
| Ticker Members |
+-------------------+-------+
| Member | Count |
+-------------------+-------+
| Attributes | 15 |
| Built-in | 6 |
| Simple | 8 |
| Maintained | 1 |
| Link | 0 |
| Events | 2 |
| Increments | 1 |
| Multilink | 0 |
| Internal | 3 |
| Array | 0 |
| Foreign | 0 |
+-------------------+-------+
| All | 21 |
+-------------------+-------+
+----------------------------------------------------------------------------------------------+
| Ticker Events |
+-----------+--------------+--------------+--------------+--------------+--------------+-------+
| event | time calcs | censored | occurrences | per entity | max in queue | MB |
+-----------+--------------+--------------+--------------+--------------+--------------+-------+
| NewPerson | 622150 | 1 | 622149 | 622149.0000 | 1 | 0 |
| TickEvent | 202 | 0 | 201 | 201.0000 | 1 | 0 |
+-----------+--------------+--------------+--------------+--------------+--------------+-------+
| All | | | | | | 0 |
+-----------+--------------+--------------+--------------+--------------+--------------+-------+
Note: MB does not include entity members
+-------------------------------------------------------------------------------------------+
| Ticker Tables |
+--------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| table | rank | cells | accum | measr | colls | incrmnts | per entity | MB |
+--------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| TickerEvents | 2 | 603 | 1 | 1 | 0 | 253 | 253.0000 | 0 |
+--------------+-------+----------+-------+-------+-------+----------+--------------+-------+
| All | | | | | | | | 0 |
+--------------+-------+----------+-------+-------+-------+----------+--------------+-------+
Note: MB does not include entity members
+------------------------------------------------+
| Ticker Members (detail) |
+----------------------------------------+-------+
| member | bytes |
+----------------------------------------+-------+
| Attributes: | |
| Built-in: | |
| age | 8 |
| case_seed | 8 |
| censor_time | 8 |
| entity_id | 4 |
| events | 2 |
| time | 8 |
| Simple: | |
| event_count | 4 |
| event_type | 1 |
| exogenous_births | 1 |
| integer_year | 4 |
| premier_tic | 1 |
| prochain_tic | 8 |
| ps | 1 |
| year | 1 |
| Maintained: | |
| endogenous_conceptions | 1 |
| Link: | |
| Events: | |
| NewPerson | 24 |
| TickEvent | 24 |
| Increments: | |
| TickerEvents increment | 32 |
| Multilink: | |
| Internal: | |
| TickerEvents (inevent) event_count | 4 |
| event_count (lagged) | 4 |
| event_count (counter at lagged) | 8 |
| Array: | |
| Foreign: | |
+----------------------------------------+-------+
| Sum of member bytes | 156 |
| Bytes per entity | 208 |
| Storage efficiency (%) | 75.0 |
+----------------------------------------+-------+
********************************************
* Resource Use Detail for Derived Tables *
********************************************
+------------------------------------------------------------------+
| Derived Tables |
+-------------------------------+-------+----------+-------+-------+
| derived table | rank | cells | measr | MB |
+-------------------------------+-------+----------+-------+-------+
| IM_GMM_KeyInputs | 1 | 7 | 1 | 0 |
| IM_IncidenceRR | 3 | 24480 | 1 | 0 |
| IM_MajorGeneBirthDistribution | 1 | 6 | 1 | 0 |
| IM_OncogenesisRR | 3 | 24480 | 1 | 0 |
| IM_PolygeneBirthDistribution | 1 | 51 | 1 | 0 |
| IM_RiskEvaluationAge | 0 | 1 | 1 | 0 |
+-------------------------------+-------+----------+-------+-------+
| All | | | | 0 |
+-------------------------------+-------+----------+-------+-------+
Resource Use Report - End
- 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++
- Authored Model Documentation
- Built-in Attributes
- Censor Event Time
- Create Import Set
- Derived Tables
- Entity Attributes in C++
- Entity Function Hooks
- Entity Member Packing
- Entity Tables
- Enumerations
- Events
- Event Trace
- External Names
- Generated Model Documentation
- Groups
- Illustrative Model
Align1 - Lifecycle Attributes
- Local Random Streams
- Memory Use
- Microdata Output
- Model Code
- Model Documentation
- Model Languages
- Model Localization
- Model Metrics Report
- Model Resource Use
- Model Symbols
- Parameter and Table Display and Content
- Population Size and Scaling
- Screened Tables
- Symbol Labels and Notes
- Tables
- Test Models
- Time-like and Event-like Attributes
- Use Modules
- Weighted Tabulation
- File-based Parameter Values
- 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 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