Skip to content

Latest commit

 

History

History
181 lines (134 loc) · 12.8 KB

V3_to_V4_ParameterMigrationGuide.md

File metadata and controls

181 lines (134 loc) · 12.8 KB

LDAR-Sim V4 Parameter Migration Guide

Purpose

This guide is intended to assist users who wish to update to LDAR-Sim V4 by providing instructions on transferring as much of the existing V3 parameters to V4 format. Do note that new behavior has been introduced in V4 and some existing behavior has been changed, thus, it is impossible to transfer all parameter files and inputs.

What changed between V3 and V4

The majority of the LDAR-Sim parameters from V3 still exist in V4, but many of them have been renamed or reworked. Some parameters have been removed entirely. There are many new input files users can provide to define the modelled infrastructure in more granularity and previously existing input files have mostly been removed or reworked.

Guidance on moving from V3 to V4

When moving from V3 to V4, it is advised to read the updated user manual to get an initial understanding of the scope of all the changes that have occurred. Users will need to make new input files in order to run V4 simulations: Critically users will need a sites file and the new emissions file to run any simulations. Many parameters have been changed or renamed. Reference the Parameter File Changes section for more detailed information. It may be easier for users to attempt to parameterize the V4 parameters while referencing the user manual for aid instead of attempting to "migrate" V3 simulation parameters.

Parameter File Changes

Simulation Settings

Simulation Settings: Renamed Parameters

V3 Parameter V4 Parameter Notes
n_processes processes_count None
n_simulations simulation_count None

Simulation Settings: Removed Parameters

V3 Parameter Notes
print_from_simulations now always enabled
pregenerate leaks now always enabled
outputs functionality moved to output parameters
start_date moved to virtual world
end_date moved to virtual world
reference_program removed until feature is necessary again

Simulation Settings: New Parameters

No new parameters were introduced in simulation settings.

Virtual World

Virtual World: Renamed Parameters

V3 Parameter V4 Parameter Notes
infrastructure_file infrastructure: sites_file The infrastructure_file is now just one of the files that define the virtual world. See the user_manual on new infrastructure parameters in the virtual world for more information
repair_delay repairs: delay repair_delay was moved under the repairs heading and renamed to delay
emissions: LPR emissions: repairable_emissions: emissions_production_rate Not quite just a rename, but the functionality is very similar. See the relevant section in the user manual for more details.
NRD emissions: repairable_emissions: duration Not quite just a rename, but the functionality is very similar. See the relevant section in the user manual for more details.

Virtual World: Removed Parameters

V3 Parameter Notes
weather_is_hourly Weather functionality has been streamlined
emissions: consider_venting Emissions granularity has been reworked. See emissions section and all emissions relating parameters in the user manual for more information
emissions: leak_dist_params Effectively moved this functionality into the emissions file
emissions: leak_dist_type Effectively moved this functionality into the emissions file
leak_file Effectively moved this functionality into the emissions file
emissions: leak_file_use Fit functionality has been removed. This is to avoid scenarios where emissions rates an incorrectly fit to a lognormal distribution when the data is not lognormal
emissions: max_leak_rate Effectively moved this functionality into the emissions file
emissions: units Effectively moved this functionality into the emissions file
n_init_leaks_prob Removed. To be reintroduced in later updates as needed
n_init_days Removed. To be reintroduced in later updates as needed

Virtual World: New Parameters

New Parameter Notes
start_date Moved to virtual world from simulation_settings
end_date Moved to virtual world from simulation_settings
repairs: cost Moved to virtual world from program parameters
infrastructure: site_type_file See relevant section in the user manual
infrastructure: equipment_group_file See relevant section in the user manual
infrastructure: sources_file See relevant section in the user manual
emissions: emissions_file See relevant section in the user manual
emissions: repairable_emissions: emissions_rate_source See relevant section in the user manual
emissions: repairable_emissions: multiple_emissions_per_source See relevant section in the user manual
emissions: non_repairable_emissions: emissions_production_rate See relevant section in the user manual
emissions: non_repairable_emissions: emissions_rate_source See relevant section in the user manual
emissions: non_repairable_emissions: duration See relevant section in the user manual
emissions: non_repairable_emissions: multiple_emissions_per_source See relevant section in the user manual

3. Programs

Programs: Changes To Existing Parameters

V3 Parameter Notes
parameter_level The default value for parameter_level for program parameters has been changed from program to programs

Programs: Renamed Parameters

V3 Parameter V4 Parameter Notes
economics: CWP_CH4 economics: global_warming_potential_CH4
economics: sale_price_natgas economics: sale_price_of_natural_gas Note: the units of this parameter have changed

Programs: Removed Parameters

V3 Parameter Notes
economics: carbon_price_tonnesCO2e Removed due to limited use in outputs
economics: cost_CCUS Removed due to limited use in outputs
economics: verification_cost Removed as functionally this can be added to repairs: cost and does not need it's own functionality
repair_costs Moved to virtual world

Parameters: New Parameters

New Parameter Notes
duration_estimate: duration_factor See relevant section in the user manual
duration_estimate: duration_method See relevant section in the user manual

4. Methods

Note there are now two default method parameter files: One for mobile deployment_type methods and one for stationary deployment_type methods. See method parameters in the user manual for more details.

Methods: Changes To Existing Parameters

V3 Parameter Notes
parameter_level The default value for parameter_level for method parameters has been changed from method to methods

Methods: Renamed Parameters

V3 Parameter V4 Parameter Notes
label method_name
sensor: MDL sensor: minimum_detection_limit
n_crews crew_count
RS surveys_per_year
time survey_time
t_bt_sites time_between_sites
weather_envs weather_envelopes
weather_envs: precip weather_envelopes: precipitation
weather_envs: temp weather_envelopes: temperature
weather_envs: wind weather_envelopes: wind

Methods: Removed Parameters

V3 Parameter Notes
sensor: QE Replaced with quantification_error heading, under which are new quantification error parameters.
mod_loc Removed as with new object oriented structure type can support this when new sensor types are properly implemented
cost: per_hour Removed as it was misleading, LDAR-SIm functions on a day timescale
scheduling: LDAR_crew_init_location Removed all routing parameters as it was not fully functional
scheduling: home_base-files Removed all routing parameters as it was not fully functional
scheduling: travel_speeds Removed all routing parameters as it was not fully functional
scheduling: min_time_bt_surveys New scheduling algorithm uses queue based scheduling, removing the need for this parameter
follow_up: instant_threshold_type Instant threshold is now fixed to an absolute threshold
follow_up: min_followups Removed. To be reimplemented if needed
follow_up: min_followup_type Removed. To be reimplemented if needed
follow_up: min_followup_days_to_end Removed. To be reimplemented if needed
follow_up: instant_threshold_type Threshold is now fixed to an absolute threshold

Methods: New Parameters

New Parameter Notes
sensor: quantification_error: quantification_parameters See relevant section in the user manual
sensor: quantification_type: quantification_parameters See relevant section in the user manual
rolling_average : small_window stationary methods only. See relevant section in the user manual
rolling_average : large_window stationary methods only. See relevant section in the user manual
rolling_average : small_window_threshold stationary methods only. See relevant section in the user manual
rolling_average : large_window_threshold stationary methods only. See relevant section in the user manual

Input Files

Unchanged Input Files

The weather file has remained unchanged from V3 to V4.

Infrastructure

A new, much more granular infrastructure design has been introduced. See infrastructure and virtual world defining files sections in the user manual for more information.

Emissions File (New to V4)

New to V4 is a new file called the Emissions Fie. This file is mandatory to run any V4 simulations. Read more about it in the User Manual here. It must be set in the virtual world parameters, see the relevant section here.