OasisLMF · sambles · Nov 5, 2025 · Aug 29, 2025 · Sep 5, 2025
diff --git a/docs/html/Contents.html b/docs/html/Contents.html
diff --git a/docs/html/CoreComponents.html b/docs/html/CoreComponents.html
diff --git a/docs/html/DataConversionComponents.html b/docs/html/DataConversionComponents.html
diff --git a/docs/html/FinancialModule.html b/docs/html/FinancialModule.html
diff --git a/docs/html/Introduction.html b/docs/html/Introduction.html
diff --git a/docs/html/MultiPeril.html b/docs/html/MultiPeril.html
diff --git a/docs/html/ORDOutputComponents.html b/docs/html/ORDOutputComponents.html
diff --git a/docs/html/OutputComponents.html b/docs/html/OutputComponents.html
diff --git a/docs/html/Overview.html b/docs/html/Overview.html
diff --git a/docs/html/README.html b/docs/html/README.html
diff --git a/docs/html/RandomNumbers.html b/docs/html/RandomNumbers.html
diff --git a/docs/html/ReferenceModelOverview.html b/docs/html/ReferenceModelOverview.html
diff --git a/docs/html/Specification.html b/docs/html/Specification.html
diff --git a/docs/html/StreamConversionComponents.html b/docs/html/StreamConversionComponents.html
diff --git a/docs/html/ValidationComponents.html b/docs/html/ValidationComponents.html
diff --git a/docs/html/Workflows.html b/docs/html/Workflows.html
diff --git a/docs/html/fmprofiles.html b/docs/html/fmprofiles.html
diff --git a/docs/md/DataConversionComponents.md b/docs/md/DataConversionComponents.md
@@ -4,15 +4,20 @@
 The following components convert input data in csv format to the binary format required by the calculation components in the reference model;
 
 **Static data**
+* **[aggregatevulnerabilitytobin](#aggregatevulnerability)** converts the aggregate vulnerability data. 
 * **[damagebintobin](#damagebins)** converts the damage bin dictionary. 
 * **[footprinttobin](#footprint)** converts the event footprint.
+* **[lossfactorstobin](#lossfactors)** converts the lossfactors data. 
 * **[randtobin](#rand)** converts a list of random numbers. 
 * **[vulnerabilitytobin](#vulnerability)** converts the vulnerability data.
+* **[weightstobin](#weights)** converts the weights data.
 
 A reference [intensity bin dictionary](#intensitybins) csv should also exist, although there is no conversion component for this file because it is not needed for calculation purposes. 
 
 **Input data**
+* **[amplificationtobin](#amplifications)** converts the amplifications data.
 * **[coveragetobin](#coverages)** converts the coverages data.
+* **[ensembletobin](#ensemble)** converts the ensemble data.
 * **[evetobin](#events)** converts a list of event_ids.
 * **[itemtobin](#items)** converts the items data.
 * **[gulsummaryxreftobin](#gulsummaryxref)** converts the gul summary xref data.
@@ -24,19 +29,25 @@ A reference [intensity bin dictionary](#intensitybins) csv should also exist, al
 * **[occurrencetobin](#occurrence)** converts the event occurrence data.
 * **[returnperiodtobin](#returnperiod)** converts a list of return periods.
 * **[periodstobin](#periods)** converts a list of weighted periods (optional).
+* **[quantiletobin](#quantile)** converts a list of quantiles (optional).
 
 These components are intended to allow users to generate the required input binaries from csv independently of the original data store and technical environment. All that needs to be done is first generate the csv files from the data store (SQL Server database, etc).
 
 The following components convert the binary input data required by the calculation components in the reference model into csv format;
 
 **Static data**
+* **[aggregatevulnerabilitytocsv](#aggregatevulnerability)** converts the aggregate vulnerability data. 
 * **[damagebintocsv](#damagebins)** converts the damage bin dictionary. 
 * **[footprinttocsv](#footprint)** converts the event footprint.
+* **[lossfactorstocsv](#lossfactors)** converts the lossfactors data. 
 * **[randtocsv](#rand)** converts a list of random numbers. 
 * **[vulnerabilitytocsv](#vulnerability)** converts the vulnerability data.
+* **[weightstocsv](#weights)** converts the weights data.
 
 **Input data**
+* **[amplificationtocsv](#amplifications)** converts the amplifications data.
 * **[coveragetocsv](#coverages)** converts the coverages data.
+* **[ensembletocsv](#ensemble)** converts the ensemble data.
 * **[evetocsv](#events)** converts a list of event_ids.
 * **[itemtocsv](#items)** converts the items data.
 * **[gulsummaryxreftocsv](#gulsummaryxref)** converts the gul summary xref data.
@@ -48,11 +59,43 @@ The following components convert the binary input data required by the calculati
 * **[occurrencetocsv](#occurrence)** converts the event occurrence data.
 * **[returnperiodtocsv](#returnperiod)** converts a list of return periods.
 * **[periodstocsv](#returnperiod)** converts a list of weighted periods (optional).
+* **[quantiletocsv](#quantile)** converts a list of quantiles (optional).
 
 These components are provided for the convenience of viewing the data and debugging.
 
 ## Static data
 
+ <a id="aggregatevulnerability"></a>
+### aggregate vulnerability
+***
+The aggregate vulnerability file is  required for the gulmc component. It contains the conditional distributions of damage for each intensity bin and for each vulnerability_id. This file must have the following location and filename;
+
+* static/aggregate_vulnerability.bin
+
+##### File format
+
+The csv file should contain the following fields and include a header row.
+
+
+| Name                           | Type   |  Bytes | Description                                   | Example     |
+|:-------------------------------|--------|--------| :---------------------------------------------|------------:|
+| aggregate_vulnerability_id     | int    |    4   | Oasis vulnerability_id                        |     45      |
+| vulnerability_id               | int    |    4   | Oasis vulnerability_id                        |     45      |
+
+If this file is present, the weights.bin or weights.csv file must also be present. The data should not contain nulls.
+
+##### aggregatevulnerabilitytobin
+```
+$ aggregatevulnerabilitytobin < aggregate_vulnerability.csv > aggregate_vulnerability.bin
+```
+
+##### aggregatevulnerabilitytocsv
+```
+$ aggregatevulnerabilitytocsv < aggregate_vulnerability.bin > aggregate_vulnerability.csv
+```
+
+[Return to top](#dataconversioncomponents)
+
  <a id="damagebins"></a>
 ### damage bin dictionary
 ***
@@ -197,6 +240,37 @@ $ footprinttocsv -z > footprint.csv
 
 [Return to top](#dataconversioncomponents)
 
+<a id="lossfactors"></a>
+### Loss Factors
+***
+The lossfactors binary maps the event_id/amplification_id pairs with post loss amplification factors, and is supplied by the model providers. The first 4 bytes are preserved for future use and the data format is as follows. It is required by Post Loss Amplification (PLA) workflow must have the following location and filename;
+
+* static/lossfactors.bin
+
+#### File format
+The csv file should contain the following fields and include a header row.
+
+| Name              | Type   |  Bytes | Description                                               | Example     |
+|:------------------|--------|--------| :---------------------------------------------------------|------------:|
+| event_id          | int    |    4   | Event ID                                                  |     1       |
+| count             | int    |    4   | Number of amplification IDs associated with the event ID  |     1       |
+| amplification_id  | int    |    4   | Amplification ID                                          |     1       |
+| factor            | float  |    4   | The uplift factor                                         |     1.01    |
+
+All fields must not have null values. The csv file will not contain the count, and the conversion tools will add/remove this count.
+
+##### lossfactorstobin
+```
+$ lossfactorstobin < lossfactors.csv > lossfactors.bin
+```
+
+##### lossfactorstocsv
+```
+$ lossfactorstocsv < lossfactors.bin > lossfactors.csv
+```
+
+[Return to top](#dataconversioncomponents)
+
 <a id="rand"></a>
 ### Random numbers 
 ***
@@ -294,8 +368,67 @@ $ vulnerabilitytocsv -z > vulnerability.csv
 ```
 [Return to top](#dataconversioncomponents)
 
+<a id="weights"></a>
+### Weights
+***
+The vulnerability weights binary contains the the weighting of each vulnerability function in all areaperil IDs. The data format is as follows. It is required by gulmc with the aggregate_vulnerability file and must have the following location and filename;
+
+* static/weights.bin
+
+#### File format
+The csv file should contain the following fields and include a header row.
+
+| Name              | Type   |  Bytes | Description                                               | Example     |
+|:------------------|--------|--------| :---------------------------------------------------------|------------:|
+| areaperil_id      | int    |    4   | Areaperil ID                                              |     1       |
+| vulnerability_id  | int    |    4   | Vulnerability ID                                          |     1       |
+| weight            | float  |    4   | The weighting factor                                      |     1.0     |
+
+All fields must not have null values.
+
+##### weightstobin
+```
+$ weightstobin < weights.csv > weights.bin
+```
+
+##### weightstocsv
+```
+$ weightstocsv < weights.bin > weights.csv
+```
+
+[Return to top](#dataconversioncomponents)
+
 ## Input data
 
+<a id="amplifications"></a>
+### Amplifications
+***
+The amplifications binary contains the list of item IDs mapped to amplification IDs. The data format is as follows. It is required by Post Loss Amplification (PLA) workflow must have the following location and filename;
+
+* input/amplifications.bin
+
+#### File format
+The csv file should contain the following fields and include a header row.
+
+| Name              | Type   |  Bytes | Description                                   | Example     |
+|:------------------|--------|--------| :---------------------------------------------|------------:|
+| item_id           | int    |    4   | Item ID                                       |     1       |
+| amplification_id  | int    |    4   | Amplification ID                              |     1       |
+
+The item_id must start from 1 and must be contiguous and not have null values. The binary file only contains the amplification IDs and assumes the item_ids would start from 1 and are contiguous.
+
+##### amplificationtobin
+```
+$ amplificationtobin < amplifications.csv > amplifications.bin
+```
+
+##### amplificationtocsv
+```
+$ amplificationtocsv < amplifications.bin > amplifications.csv
+```
+
+[Return to top](#dataconversioncomponents)
+
 <a id="coverages"></a>
 ### Coverages
 ***
@@ -325,6 +458,31 @@ $ coveragetocsv < coverages.bin > coverages.csv
 
 [Return to top](#dataconversioncomponents)
 
+<a id="ensemble"></a>
+### ensemble
+***
+The ensemble file is used for ensemble modelling (multiple views) which maps sample IDs to particular ensemble ID groups. It is an optional file for use with AAL and LEC. It must have the following location and filename;
+* input/ensemble.bin
+
+##### File format
+The csv file should contain a list of event_ids (integers) and include a header.
+
+| Name              | Type   |  Bytes | Description         | Example     |
+|:------------------|--------|--------| :-------------------|------------:|
+| sidx              | int    |    4   | Sample ID           |   1         |
+| ensemble_id       | int    |    4   | Ensemble ID         |   1         |
+
+##### ensembletobin
+```
+$ ensembletobin < ensemble.csv > ensemble.bin
+```
+
+##### ensembletocsv
+```
+$ ensembletocsv < ensemble.bin > ensemble.csv
+```
+[Return to top](#dataconversioncomponents)
+
 <a id="events"></a>
 ### events
 ***
@@ -818,6 +976,34 @@ $ periodstocsv < periods.bin > periods.csv
 
 [Return to top](#dataconversioncomponents)
 
+<a id="quantile"></a>
+### Quantile
+***
+The quantile binary file contains a list of user specified quantile floats. The data format is as follows. It is optionally used by the Quantile Event/Period Loss tables and must have the following location and filename;
+
+* input/quantile.bin
+
+#### File format
+The csv file should contain the following fields and include a header row.
+
+| Name              | Type   |  Bytes | Description                                               | Example     |
+|:------------------|--------|--------| :---------------------------------------------------------|------------:|
+| quantile          | float  |    4   | Quantile float                                            |     0.1     |
+
+All fields must not have null values.
+
+##### quantiletobin
+```
+$ quantiletobin < quantile.csv > quantile.bin
+```
+
+##### quantiletocsv
+```
+$ quantiletocsv < quantile.bin > quantile.csv
+```
+
+[Return to top](#dataconversioncomponents)
+
 [Go to 4.5 Stream conversion components section](StreamConversionComponents.md)
 
 [Back to Contents](Contents.md)
diff --git a/docs/pdf/ktools.pdf b/docs/pdf/ktools.pdf