Adding emission estimation into routing branch

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,50 @@
+name: 🐞Bug report
+description: Report a bug or defect in LDAR-Sim
+title: "[BUG] Brief Description"
+labels: ["bug"]
+body:
+- type: textarea
+  attributes: 
+    label: Bug/Defect description
+    description: Describe the bug/defect in as much detail as possible. Be clear and concise.
+  validations: 
+    required: true
+- type: textarea
+  attributes: 
+    label: Steps to reproduce
+    description: Describe steps to reproduce the bug/defect. Be as accurate as possible in describing the steps to reproduce.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Evidence
+    description: |
+      Include screenshots, error messages, output files and any other material that may be useful here to explain what happened.
+
+      **TIP** You can attach images or output files by clicking this area to highlight it and then dragging files in.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: Describe what you expected to happen. How is it different from what happened? Be clear and concise.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Inputs and Parameters
+    description: As part of the submissions for a bug report, include a zipped folder containing the LDAR-Sim input files and parameters if relevant and they do not contain confidential information. If they do contain confidential information, if it is possible to remove or redact that information and submit the files, it is recommended to do so.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Version Number
+    description: Include the version number of the LDAR-Sim version that was running when the bug occurred.
+  validations: 
+    required: true
+- type: textarea
+  attributes:
+    label: Additional Context
+    description: Include any other context about the problem here.
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/discussions.yaml

@@ -0,0 +1,20 @@
+name: "💬Discussions, 💭Ideas or❓Questions"
+description: "Discussion/Brainstorming/Questions for LDAR-Sim"
+title: "[MISC] Brief Description"
+labels: ["discussion"]
+body:
+- type: textarea
+  attributes:
+    label: "Discussion/Brainstorming/Question description"
+    description: |
+      Describe the topic of discussion or idea in as much detail as possible.
+      **If this is a question, please add an additional label -question-**
+  validations:
+    required: true
+- type: checkboxes
+  attributes:
+    label: "Is this a duplicate/existing topic or question?"
+    description: "Please search to see if an issue already exists for this discussion/idea/question."
+    options:
+      - label: I have searched to see if an issue already exists for this topic.
+        required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,35 @@
+name: Feature/Enhancement request
+description: Request new functionality for LDAR-Sim
+title: "[FEAT] Brief Description"
+labels: ['enhancement']
+body:
+- type: textarea
+  attributes: 
+    label: Requested Feature/Enhancement
+    description: Describe the feature/enhancement being requested in detail. Be clear and concise. 
+  validations: 
+    required: true
+- type: textarea
+  attributes: 
+    label: Need for feature/Enhancement
+    description: Describe why the feature/enhancement is important. 
+  validations: 
+    required: true
+- type: textarea
+  attributes: 
+    label: Problem to solve
+    description: Describe what problem the feature/enhancement will solve, if any. 
+  validations: 
+    required: false
+- type: textarea
+  attributes: 
+    label: Implementation Ideas
+    description: Describe the ideas, if any that you have for how to solve the problem outlined as part of this feature/enhancement request. 
+  validations: 
+    required: false
+- type: textarea
+  attributes: 
+    label: Additional context
+    description: Include any other context about the feature request here. 
+  validations: 
+    required: false

.github/pull_request_template.md

@@ -0,0 +1,29 @@
+# Pull Request Key Information
+
+## Reason for change
+
+Describe the reason why the pull request exists.
+
+## What was changed
+
+Describe what was changed as part of the pull request.
+
+## Intended Purpose
+
+Describe the purpose of the pull request and what it aims to accomplish.
+
+## Level of version change required
+
+Describe the level of version change required with this change.
+
+## Testing Completed
+
+Describe the level of testing completed for the change. Include any relevant logs and test results.
+
+## Target Issue
+
+Put GitHub keywords to link the pull request to the target issue here. For example: Closes #XX.
+
+## Additional Information
+
+Include any other important information here.

.gitignore

@@ -1,5 +1,6 @@
 
 # Ignore
+*.log
 *.iml
 *.xml
 *.pyc
@@ -8,8 +9,14 @@
 **/outputs/
 *.nc
 *.p
+.hypothesis/
+LDAR_Sim/inputs/
+LDAR_Sim/simulations/
+Benchmarking/
+**/BenchmarkingResults
+**/generator/
+LDAR_Sim/Logs/
 # Include
 !weather_alberta.nc
 !weather_marcellus.nc
-!weather_permian.nc
-**/generator/
+!weather_permian.nc

Guides/Feature Guides/Sensitivity_Analysis.md

@@ -0,0 +1,187 @@
+# LDAR-Sim Sensitivity Analysis Guide
+
+## Introduction
+
+The purpose of this guide is to provide users with instructions and examples on how to run the LDAR-Sim Sensitivity Analysis module.
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Table of Contents](#table-of-contents)
+- [Key Sensitivity Analysis Information](#key-sensitivity-analysis-information)
+  - [On Having Multiple Programs](#on-having-multiple-programs)
+- [Setup](#setup)
+  - [Creating the Sensitivity Analysis Information File](#creating-the-sensitivity-analysis-information-file)
+    - [Virtual World Level Sensitivity Analysis](#virtual-world-level-sensitivity-analysis)
+    - [Program Level Sensitivity Analysis](#program-level-sensitivity-analysis)
+    - [Method Level Sensitivity Analysis](#method-level-sensitivity-analysis)
+- [Running LDAR-Sim Sensitivity Analysis](#running-ldar-sim-sensitivity-analysis)
+  - [Example Command](#example-command)
+
+## Key Sensitivity Analysis Information
+
+Sensitivity Analysis module is performed based on the parameter level. This means that either virtual world parameters, program parameters for one or programs or method parameters for one or more methods can be varied for Sensitivity Analysis, but not at the same time.
+
+Multiple parameters can be varied at once for sensitivity analysis, however it is important to properly understand how this works. Variations for parameters in the Sensitivity Analysis module are provided as lists, for example, performing Sensitivity Analysis on virtual world parameters:
+
+```yml
+emissions:
+  repairable_emissions:
+    production_rate: [0.0065, 0.013]
+    duration: [365, 730]
+```
+
+is a potential input to the Sensitivity Analysis file, which will generate two sets of simulations. The first set will have:
+
+```yml
+emissions:
+  repairable_emissions:
+    production_rate: 0.0065
+    duration: 365
+```
+
+and the second set will have:
+
+```yml
+emissions:
+  repairable_emissions:
+    production_rate: 0.013
+    duration: 730
+```
+
+### On Having Multiple Programs
+
+One key intricacy of LDAR-Sim Sensitivity Analysis functionality is that it is intended to support only a single program at time. If the simulation parameters include more than one program, one will be chosen at random for sensitivity analysis.
+
+Specifically, outputs for virtual world level sensitivity analysis will compare the performance of a single program on different virtual worlds.
+
+Program level sensitivity analysis will compare the performance of variations of a base program against each other.
+
+Method level sensitivity analysis will compare the performance of variations of a program varied by generating variations of one or more of it's methods.
+
+## Setup
+
+The LDAR-Sim sensitivity analysis module runs using standard LDAR-Sim parameter files with one new addition: the new sensitivity info parameter file.
+It is recommend to change the output directory in the simulation settings parameters as so not to overwrite existing outputs.
+
+```yml
+output_directory: {new output location}
+```
+
+### Creating the Sensitivity Analysis Information File
+
+The Sensitivity Analysis Information File must be a .yaml or .yml file that follows a specific format.
+
+```yml
+Sensitivity Parameter Level: # The level of parameters on which to perform sensitivity analysis. Options are: "virtual_world", "programs" or "methods".
+Sensitivity Sets Provided: # How many different sensitivity analysis permutations are described (The length of the list of values to evaluate for each parameters). For example: if we have Parameter: [Value 1, Value 2] that would be a value of 2.
+Sensitivity Sets: 
+  # Parameters and Lists of values to set for those parameters that fall under the specified parameter level.
+  # Looks like:
+  # Parameter: [Value 1, Value 2, Value 3]
+Sensitivity Summary Outputs Information: 
+  Confidence Interval: # Can be either 1 number or a list of two numbers.
+    # One number, for example 95, will result in sensitivity analysis outputs reporting the 100-(CI/2)th and (CI/2)th percentile (2.5th and 97.5th percentiles). Two numbers, for example 5 and 90 will results in sensitivity analysis outputs reporting those percentiles (5th and 90th percentiles)
+```
+
+This format varies slightly based on the parameter level on which Sensitivity Analysis is being performed. See the following examples below for different parameter levels.
+
+#### Virtual World Level Sensitivity Analysis
+
+```yml
+Sensitivity Parameter Level: "virtual_world"
+Sensitivity Sets Provided: 3
+Sensitivity Sets:
+  emissions:
+    repairable_emissions:
+      emissions_production_rate: [0.00325, 0.0065, 0.013]
+      duration: [182, 365, 730]
+Sensitivity Summary Outputs Information:
+  Confidence Interval: [85]
+```
+
+#### Program Level Sensitivity Analysis
+
+```yml
+Sensitivity Parameter Level: "programs"
+Sensitivity Sets Provided: 3
+Sensitivity Sets:
+  - Program Name: "Example_Program"
+    Program Sensitivity Parameters:
+      economics: 
+        verification_cost: [100, 200, 300]
+Sensitivity Summary Outputs Information:
+  Confidence Interval: [85]
+```
+
+#### Method Level Sensitivity Analysis
+
+##### One Method
+
+```yml
+Sensitivity Parameter Level: "methods"
+Sensitivity Sets Provided: 3
+Sensitivity Sets:
+  - Method Name: "Example_Method"
+    Method Sensitivity Parameters:
+      surveys_per_year: [1,2,3]
+Sensitivity Summary Outputs Information:
+  Confidence Interval: [85]
+```
+
+##### Two Methods
+
+```yml
+Sensitivity Parameter Level: "methods"
+Sensitivity Sets Provided: 3
+Sensitivity Sets:
+  - Method Name: "Example_Method"
+    Method Sensitivity Parameters:
+      surveys_per_year: [1,2,3]
+  - Method Name: "Example_Method_2"
+    Method Sensitivity Parameters:
+      surveys_per_year: [2,4,6]
+Sensitivity Summary Outputs Information:
+  Confidence Interval: [85]
+```
+
+## Running LDAR-Sim Sensitivity Analysis
+
+LDAR-Sim sensitivity analysis is run through the command line, similar to LDAR-Sim. The command takes the form:
+
+```cmd
+-p <path to your LDAR-Sim parameters> --sensitivity_info <path to sensitivity info file>
+```
+
+or
+
+```cmd
+--in_dir <path to your LDAR-Sim parameters> --sensitivity_info <path to sensitivity info file>
+```
+
+Where the first argument (-P or --in_dir) indicates that the following argument will be the path to the input directory where the simulation parameter files are contained.
+
+The second argument must be the path to the input directory, for example:
+
+```cmd
+./simulations
+```
+
+For parameter files inside the simulations folder in the inner LDAR-Sim file folder.
+
+The third argument (--sensitivity_info) indicates that the following argument will be the path to the new sensitivity information file.
+
+The fourth argument must be the path to the sensitivity info file, for example:
+
+```cmd
+./simulations/sens_info.yml
+```
+
+For sensitivity information file named sens_info located in the simulations folder in the inner LDAR-SIm folder.
+**Note: Remember to include the file extension in the file path for the sensitivity info file (.yml)**
+
+### Example Command
+
+```cmd
+-p simulations/example_sensitivity_analysis --sensitivity_info simulations/example_sensitivity_analysis/sensitivity_info.yml
+```