pyelq
The python Emission Localization and Quantification (pyELQ) code aims to maximize effective use of existing measurement data, especially from continuous monitoring solutions. The code has been developed to detect, localize, and quantify methane emissions from concentration and wind measurements.
Science Score: 39.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.7%) to scientific vocabulary
Keywords from Contributors
Repository
The python Emission Localization and Quantification (pyELQ) code aims to maximize effective use of existing measurement data, especially from continuous monitoring solutions. The code has been developed to detect, localize, and quantify methane emissions from concentration and wind measurements.
Basic Info
- Host: GitHub
- Owner: sede-open
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://sede-open.github.io/pyELQ/
- Size: 14.7 MB
Statistics
- Stars: 15
- Watchers: 1
- Forks: 9
- Open Issues: 1
- Releases: 19
Metadata Files
README.md
pyELQ
This repository contains the Python Emission Localization and Quantification software we call pyELQ. It is code used for gas dispersion modelling, in particular methane emissions detection, localization and quantification.
Background
The python Emission Localization and Quantification (pyELQ) code aims to maximize effective use of existing measurement data, especially from continuous monitoring solutions. The code has been developed to detect, localize, and quantify methane emissions from concentration and wind measurements. It can be used in combination with point or beam sensors that are placed strategically on an area of interest.
The algorithms in the pyELQ code are based a Bayesian statistics framework. pyELQ can ingest long-term concentration and wind data, and it performs an inversion to predict the likely strengths and locations of persistent methane sources. The goal is to arrive at a plausible estimate of methane emissions from an area of interest that matches the measured data. The predictions from pyELQ come with uncertainty ranges that are representative of probability density functions sampled by a Markov Chain Monte Carlo method. Time series of varying length can be processed by pyELQ: in general, the Bayesian inversion leads to a more constrained solution if more high-precision measurement data is available. We have tested our code under controlled conditions as well as in operating oil and gas facilities.
The information on the strength and the approximate location of methane emission sources provided by pyELQ can help operators with more efficient identification and quantification of (unexpected) methane sources, in order to start appropriate mitigating actions accordingly. The pyELQ code is being made available in an open-source environment, to support various assets in their quest to reduce methane emissions.
Use cases where the pyELQ code has been applied are described in the following papers:
IJzermans, R., Jones, M., Weidmann, D. et al. "Long-term continuous monitoring of methane emissions at an oil and gas facility using a multi-open-path laser dispersion spectrometer." Sci Rep 14, 623 (2024). (https://doi.org/10.1038/s41598-023-50081-9)
Weidmann, D., Hirst, B. et al. "Locating and Quantifying Methane Emissions by Inverse Analysis of Path-Integrated Concentration Data Using a Markov-Chain Monte Carlo Approach." ACS Earth and Space Chemistry 2022 6 (9), 2190-2198 (https://doi.org/10.1021/acsearthspacechem.2c00093)
Deployment design
The pyELQ code needs high-quality methane concentration and wind data to be able to provide reliable output on location and quantification of methane emission sources. This requires methane concentration sensors of sufficiently high precision in a layout that allows the detection of relevant methane emission sources, in combination with wind measurements of high enough frequency and accuracy. The optimal sensor layout typically depends on the prevailing meteorological conditions at the site of interest and requires multiple concentration sensors to cover the site under different wind directions.
pyELQ data interpretation
The results from pyELQ come with uncertainty ranges that are representative of probability density functions sampled by a Markov Chain Monte Carlo method. One should take these uncertainty ranges into account when interpreting the pyELQ output data. Remember that absence of evidence for methane emissions does not always imply evidence for absence of methane emissions; for instance, when meteorological conditions are such that there is no sensor downwind of a methane source during the selected monitoring period, then it will be impossible to detect, localize and quantify this particular source. Also, there are limitations to the forward dispersion model which is used in the analysis. For example, the performance of the Gaussian plume dispersion model will degrade at lower wind speeds. Therefore, careful interpretation of the data is always required.
Installing pyELQ as a package
Suppose you want to use this pyELQ package in a different project.
You can install it from PyPi through pip
pip install pyelq.
Or you could clone the repository and install it from the source code.
After activating the environment you want to install pyELQ in, open a terminal, move to the main pyELQ folder
where pyproject.toml is located and run pip install ., optionally you can pass the -e flag is for editable mode.
All the main options, info and settings for the package are found in the pyproject.toml file which sits in this repo
as well.
Examples
For some examples on how to use this package please check out these Examples
Contribution
This project welcomes contributions and suggestions. If you have a suggestion that would make this better you can simply open an issue with a relevant title. Don't forget to give the project a star! Thanks again!
For more details on contributing to this repository, see the Contributing guide.
Licensing
Distributed under the Apache License Version 2.0. See the license file for more information.
Owner
- Name: sede-open
- Login: sede-open
- Kind: organization
- Location: 2596 HR The Hague, The Netherlands
- Website: https://www.shell.com/about-us/contact-us.html
- Repositories: 101
- Profile: https://github.com/sede-open
GitHub Events
Total
- Create event: 18
- Release event: 9
- Issues event: 5
- Watch event: 3
- Delete event: 11
- Member event: 1
- Issue comment event: 5
- Push event: 42
- Pull request review comment event: 34
- Pull request review event: 40
- Pull request event: 18
- Fork event: 5
Last Year
- Create event: 18
- Release event: 9
- Issues event: 5
- Watch event: 3
- Delete event: 11
- Member event: 1
- Issue comment event: 5
- Push event: 42
- Pull request review comment event: 34
- Pull request review event: 40
- Pull request event: 18
- Fork event: 5
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| bvandekerkhof | b****f@s****m | 116 |
| TannazHajiMohammadloo | T****o@s****m | 84 |
| Matthew.Jones | M****2@s****m | 13 |
| code_reformat | 10 | |
| david.randell | d****l@s****m | 5 |
| bump_version | a****n@g****m | 3 |
| Jess S | 1****l | 2 |
| Jess S | 3****g | 1 |
| Rudy McIntyre | r****e@m****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 4
- Total pull requests: 33
- Average time to close issues: 3 months
- Average time to close pull requests: 10 days
- Total issue authors: 3
- Total pull request authors: 6
- Average comments per issue: 0.25
- Average comments per pull request: 0.12
- Merged pull requests: 26
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 2
- Pull requests: 24
- Average time to close issues: about 2 months
- Average time to close pull requests: 12 days
- Issue authors: 1
- Pull request authors: 4
- Average comments per issue: 0.0
- Average comments per pull request: 0.17
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- bvandekerkhof (2)
- rudymcintyre (1)
- davidrandell84 (1)
Pull Request Authors
- bvandekerkhof (28)
- TannazH (8)
- rudymcintyre (3)
- JessSpearing (2)
- mattj89 (2)
- whitesource-for-github-shell[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 87 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 21
- Total maintainers: 1
pypi.org: pyelq
Package for detection, localization and quantification code.
- Homepage: https://sede-open.github.io/pyELQ/
- Documentation: https://sede-open.github.io/pyELQ/
- License: Apache-2.0
-
Latest release: 1.1.4
published about 1 year ago
Rankings
Maintainers (1)
pypi.org: pyelq-sdk
Package for detection, localization and quantification code.
- Homepage: https://sede-open.github.io/pyELQ/
- Documentation: https://sede-open.github.io/pyELQ/
- License: Apache-2.0
-
Latest release: 1.0.14
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/cache v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v4 composite
- fsfe/reuse-action v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- black >=23.12.1 contributor
- isort >=5.13.2 contributor
- mkdocs-material >=9.5.7 contributor
- mkdocstrings-python >=1.8.0 contributor
- pydocstyle >=6.3.0 contributor
- pylint >=3.0.3 contributor
- pytest >=7.4.4 contributor
- pytest-cov >=4.1.0 contributor
- geojson >=3.1.0
- numpy >=1.26.2
- openmcmc >=1.0.0
- pandas >=2.1.4
- plotly >=5.18.0
- pymap3d >=3.0.1
- python ~3.11
- scikit-learn >=1.3.2
- scipy >=1.11.4
- shapely >=2.0.2
- actions/checkout v4 composite
- actions/setup-python v5 composite
- SonarSource/sonarcloud-github-action master composite
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- actions/upload-artifact v4 composite