marss2l 0.2.1__tar.gz

marss2l-0.2.1/LICENCE

@@ -0,0 +1,166 @@
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

marss2l-0.2.1/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: marss2l
+Version: 0.2.1
+Summary: MARS-S2L Plume detection, segmentation and quantification of methane plumes in Sentinel-2 and Landsat images
+Author: Gonzalo Mateo-García, Anna Vaughan
+License-Expression: LGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/gonzmg88/marss2l
+Project-URL: Bug Tracker, https://github.com/gonzmg88/marss2l/issues
+Keywords: ch4,methane,remote sensing
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Dynamic: license-file
+
+[![MARS-S2L DOI:10.48550/arXiv.2511.21777](https://img.shields.io/badge/MARSS2L%20DOI-10.48550%2FarXiv.2511.21777-blue)](https://doi.org/10.48550/arXiv.2511.21777) [![PyPI](https://img.shields.io/pypi/v/marss2l)](https://pypi.org/project/marss2l/) [![PyPI - License](https://img.shields.io/pypi/l/marss2l)](https://github.com/UNEP-IMEO-MARS/marss2l/blob/main/LICENSE) [![HF](https://img.shields.io/badge/%F0%9F%A4%97-Datasets-yellow)](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L) [![HF](https://img.shields.io/badge/%F0%9F%A4%97-Models-yellow)](https://huggingface.co/UNEP-IMEO/MARS-S2L)
+
+# <img src="./notebooks/logo.png" alt="Logo" width='7%'> MARS-S2L
+
+This package contains the operational UNEP International Methane Emissions Observatory (IMEO) pipeline for methane plume detection, segmentation, and quantification in Sentinel-2 and Landsat satellite imagery. The methods and models implemented in this package are described in:
+
+> Allen, Mateo-García, Irakulis-Loitxate et al., *Artificial intelligence for methane detection: from continuous monitoring to verified mitigation* [10.48550/arXiv.2511.21777](https://arxiv.org/abs/2511.21777)
+
+### Licence
+
+The MARS-S2L database and all trained models are released under a [Creative Commons Non-Commercial Share-Alike licence](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt). The code in this package is published under a [GNU Lesser GPL v3 licence](https://www.gnu.org/licenses/lgpl-3.0.en.html).
+
+## Install
+
+Create the `marss2lpy312` virtual environment with conda:
+
+```bash
+conda env create -f environment/conda_vm.yaml
+```
+
+Install `marss2l` package:
+
+```bash
+pip install marss2l
+```
+
+## *End-to-end* inference [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/UNEP-IMEO-MARS/marss2l/blob/main/notebooks/examples/download_and_inference.ipynb)
+
+[This tutorial](./notebooks/examples/download_and_inference.ipynb) demonstrates an *end-to-end* example of the UNEP IMEO pipeline for detecting methane plumes in Sentinel‑2 and Landsat imagery. It downloads, compute the multi-band, multi-pass (MBMP, [Irakullis‑Loitxate et al., 2022](https://doi.org/10.1021/acs.est.1c04873)) retrieval, run inference with the MARS-S2L model ([Allen et al., 2025](https://arxiv.org/abs/2511.21777)), quantify the retrieval ΔXCH₄ and estimate the flux rate of detected plumes ([Gorroño et al., 2023](https://amt.copernicus.org/articles/16/89/2023/)).
+
+**Important considerations:**
+
+- The MARS‑S2L model produce false positives.
+- Therefore any positive model output must be validated before its use. 
+- <u>**At UNEP IMEO, all plumes are manually validated by at least two independent remote sensing analysts before their publication.**</u>
+
+## Dataset [🤗](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L)
+
+The MARS-S2L database and all trained models are released under a [Creative Commons Non-Commercial Share-Alike licence](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt). 
+
+Currently the dataset is publicly available in this Hugging-Face🤗 repo: [UNEP-IMEO/MARS-S2L](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L).
+
+To download the entire dataset and trained models (~100GB) run:
+
+```bash
+hf download --local-dir /path/to/localdir/MARS-S2L \
+            --repo-type dataset UNEP-IMEO/MARS-S2L
+```
+
+The following notebooks show how to load and plot images using the `torch.Dataset` directly from the Hugging Face repository: [`notebooks/examples/plot_images_dataset_train.ipynb`](./notebooks/examples/plot_images_dataset_train.ipynb) and [`notebooks/examples/plot_plumes_dataset_test.ipynb`](./notebooks/examples/plot_plumes_dataset_test.ipynb).
+
+## Retrain the MARS-S2L model
+
+We trained the model on a A100 GPU with 80Gb RAM. In order to re-train the proposed model and the baseline run:
+
+```bash
+wandb init # select the wandb project to display the training metrics
+python -m marss2l.reproduce_training --csv_path /path/to/dataset/validated_images_all.csv\
+                                     --batch_size 128 --num_workers 16 --num_workers_val 8\
+                                     --batch_size_val 256 --n_samples_per_epoch_train 65536\
+                                     --basename_dir train_logs # Where to store the training outputs
+```
+
+This code will train 4 models the proposed MARS-S2L model and the CH4Net model both trained on the train split of the dataset. In addition it will evaluate these models in the test split of the dataset. After the training the content of the `--basename_dir` folder should be:
+
+```
+train_logs/
+├── marss2l
+│   ├── best_epoch
+│   ├── config_experiment.json
+│   └── preds_test_2023.csv
+├── ch4net
+│   ├── best_epoch
+│   ├── config_experiment.json
+│   └── preds_test_2023.csv
+├── ch4net_sim
+│   ├── best_epoch
+│   ├── config_experiment.json
+│   └── preds_test_2023.csv
+└── marss2l_nosim
+    ├── best_epoch
+    ├── config_experiment.json
+    └── preds_test_2023.csv
+
+```
+
+Where:
+* `best_epoch` are the weights of the trained model
+* `config_experiment.json` is the metadata with the configuration of the experiment
+* `preds_test_2023.csv` are the model predictions for all entries in the test set
+
+
+## Reproduce the figures
+
+In the folder `notebooks/figures` there is the code to reproduce most of the figures of the paper. These notebooks read the data directly from the Hugging Face repository. See [this README](./notebooks/figures/README.md).
+
+## Load and eval trained models
+
+The MARS-S2L model of the paper is stored in this [Hugging-Face🤗 repository](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L) in the *trained_models* folder. The files are stored following the same naming convention as described above.
+
+In order to re-run the evaluation in the test set with the trained model proposed see [this README](./notebooks/figures/README.md).
+
+## Dataset structure
+
+The file [`validated_images_all.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_all.csv) contains the metadata of all the items in the dataset. Each item comprises a Sentinel-2 or Landsat image of 200x200 pixels
+together with its concatenated background image and the cloud mask. The methane enhancement image (ΔXCH₄) in ppb is also provided for positive samples. For positive samples, a vector multipolygon with the extent of the plume in WKT format is provided. In addition, each item
+includes several metadata described in the next section. (*Images metadata description*).
+
+The file [`validated_images_plumes.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_plumes.csv) contains all validated plumes in the dataset. Notice that there are few images that contain more than one plume. 
+The content of this file is described in the *Plumes metadata description* section.
+
+### Images metadata description
+
+Column description of file [`validated_images_all.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_all.csv):
+
+| Name      | Description      | Example | 
+| ------------- | ------------- | -------- |
+|s2path| Path to S2 or Landsat image concatenated with the background image. S2 L1C image with bands: B02, B03, B04, B08, B11, B12. Landsat TOA reflectance image with bands  B02, B03, B04, B05, B06, B07 | data/train_2023/43/b82be820-fe9c-411a-af20-82cf162760a7_ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0_s2.tif |
+|cloudmaskpath| Path to cloud mask generated with CloudSEN12 with interpretation `{0 : "clear", 1: "Thick cloud", 2: "Thin cloud", 3: "Cloud shadow"}` | data/train_2023/43/b82be820-fe9c-411a-af20-82cf162760a7_ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0_cloudmask.tif |
+|ch4path| Path to the ΔXCH₄ enhancement image in ppb. Only provided for positive samples (`isplume` `True`). | data/train_2023/43/b82be820-fe9c-411a-af20-82cf162760a7_ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0_ch4.tif |
+|wind_u| U component of the wind at 10m | -1.87 |
+|wind_v| V component of the wind at 10m | 3.76 |
+|wind_source| Source where the wind data is downloaded from. | ECMWF/ERA5_LAND/HOURLY |
+|vza| Viewing zenith angle. | 5.40 |
+|sza| Solar zenith angle. | 16.32 |
+|percentage_clear| Percentage of pixels clear according to CloudSEN12 mask. | 100.0 |
+|tile| Name of the S2 or Landsat product | S2A_MSIL1C_20240613T100031_N0510_R122_T32RNS_20240613T134114 or LC08_L1TP_192040_20190601_20200828_02_T1 |
+|isplume| Whether there is a methane plume on the image or not | True |
+|ch4_fluxrate| Flux rate in kg/h if there is a plume in the tile. | 7756.50 |
+|ch4_fluxrate_std| Standard deviation of the fluxrate. | 2941.19 |
+|satellite| Name of the satellite | S2A, S2B, LC08 or LC09 |
+|tile_date| Date of acquisition | 2024-06-13 10:00:31+00:00 |
+|notified| If the image contains a plume, whether the plume was notified or not | False |
+|id_location| UUID of the site | b82be820-fe9c-411a-af20-82cf162760a7 |
+|last_update| Last time this registry was modified | 2025-05-20 10:00:31+00:00 |
+|location_name| Code of the location. | A_10 |
+|country| Country of the location | Algeria |
+|lon| Longitude of the center of the location | 9.783133 |
+|lat| Latitude of the center of the location | 28.087894 |
+|offshore| Whether the location is offshore or onshore. | False |
+|sector| Sector of the observation | Oil and Gas, Coal, Waste or Unknown |
+|observability| Given observability to the image. Clear and cloudy is computed automatically with the cloudmask (50% threshold). Additionally the analyst can change this category (e.g. if the cloudmask is not correct or if there're artifacts in the scene such as snow, smoke, shadows...). | clear, cloudy, bad_retrieval, smoke, shadow, snow, out_of_swath |
+|background_image_tile| Name of the S2 or Landsat product used as background. | S2A_MSIL1C_20240603T100031_N0510_R122_T32RNS_20240603T134002 |
+|crs| Coordinate reference system of the image | EPSG:32632 |
+|transform_a| Geotransform of the image | 10.0 |
+|transform_b| Geotransform of the image | 0.0 |
+|transform_c| Geotransform of the image | 575940.0 |
+|transform_d| Geotransform of the image | 0.0 |
+|transform_e| Geotransform of the image | -10.0 |
+|transform_f| Geotransform of the image | 3108180.0 |
+|width| Width of the image | 200 |
+|height| Height of the image | 200 |
+|window_row_off| Top left row of the location of the plume within the image (used for the simulation). | 0.0 |
+|window_col_off| Top left column of the location of the plume within the image (used for the simulation). | 62.0 |
+|window_height| Height in pixels of the plume within the image (used for the simulation). | 101.0 |
+|window_width| Width in pixels of the plume within the image (used for the simulation). | 46.0 |
+|id_loc_image| Id of the image | ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0 |
+|plume| Vector WKT representation of the plume. | MULTIPOLYGON (((9.781389 28.090856, 9.781646 28.090288, 9.781861 28.089796, 9.781818 28.089134, 9.781989 28.088622, 9.782268 28.088187, 9.782633 28.087903, 9.783105 28.087865, 9.783362 28.088244, 9.783083 28.088774, 9.78304 28.089436, 9.783148 28.090061, 9.783384 28.090705, 9.783663 28.091424, 9.783856 28.092522, 9.783642 28.093299, 9.783234 28.093905, 9.783106 28.094794, 9.783041 28.095571, 9.782312 28.096195, 9.78154 28.096422, 9.780896 28.096934, 9.779888 28.097104, 9.779352 28.096915, 9.779759 28.096063, 9.780596 28.09523, 9.781132 28.094472, 9.780896 28.093867, 9.780896 28.09309, 9.781154 28.092314, 9.781239 28.091784, 9.781154 28.091292, 9.781389 28.090856))) |
+|footprint| Vector WKT representation of the footprint of the image | POLYGON ((9.772934575210368 28.09701036650939, 9.7728039936767 28.07877712456095, 9.793361656935707 28.07865982254285, 9.7934957112434 28.09689297500473, 9.772934575210368 28.09701036650939)) |
+|split_name| Name of the split the item belongs to. One of 'train_2023', 'test_2023',  'val_2023' or 'Not Used'  | 'train_2023' |
+|case_study | Case study area of the same. | Turkmenistan |
+
+### Plumes metadata description
+
+Column description of file [`validated_images_plumes.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_plumes.csv).
+
+| Name      | Description      | Example | 
+| ------------- | ------------- | -------- |
+|id_plume | UUID of the plume | 652fd72a-4a24-4938-8646-84309f899914|
+|id_loc_image | UUID of its corresponding image | 37ecaefe-619e-4dc7-90f1-d57bd48dbf0f|
+|tile| Name of the S2 or Landsat product | S2A_MSIL1C_20240613T100031_N0510_R122_T32RNS_20240613T134114 or LC08_L1TP_192040_20190601_20200828_02_T1 |
+|tile_date| Date of acquisition | 2024-06-13 10:00:31+00:00 |
+|satellite| Name of the satellite | S2A, S2B, LC08 or LC09 |
+|lat | Latitude of the source of the plume | 28.088329877970512|
+|lon | Longitude of the source of the plume | 9.78350881586494|
+|ch4_fluxrate | Estimated flux rate of the plume in kg/h | 9639.58562343052|
+|ch4_fluxrate_std | Estimated std of the flux rate of the plume in kg/h | 3964.424919968837|
+|geometry | Plume shape | MULTIPOLYGON (((9.782459 28.090423, 9.782716 28.089211, 9.782802 28.088378, 9.783746 28.088151, 9.78396 28.089249, 9.784217 28.090953, 9.784475 28.092316, 9.784432 28.093528, 9.783788 28.095156, 9.782802 28.095383, 9.78293 28.09402, 9.782716 28.093339, 9.782201 28.092203, 9.782416 28.09118, 9.782459 28.090423)))|
+|last_update | Last time this registry was updated | 2025-05-19 05:30:16.151729+00:00|
+|window_row_off | Pixel upper left row coordinate within the image where the plume is located | 15|
+|window_col_off | Pixel upper left column coordinate within the image where the plume is located | 88|
+|window_height | Number of columns from the upper left coordinate | 82|
+|window_width | Number of rows from the upper left coordinate | 25|
+
+## Licence
+
+The MARS-S2L database, all trained models and tutorials are released under a [Creative Commons Non-Commercial Share-Alike licence](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt). 
+
+The code in this package is published under a [GNU Lesser GPL v3 licence](https://www.gnu.org/licenses/lgpl-3.0.en.html) <img src="https://www.gnu.org/graphics/lgplv3-88x31.png" alt="licence" width="80">.
+
+## Cite
+If you find this work useful, please cite:
+
+```bibtex
+@article{allen_2025,
+    title = {Artificial intelligence for methane detection: from continuous monitoring to verified mitigation},
+    author = {Allen, Anna and Mateo-Garcia, Gonzalo and Irakulis-Loitxate, Itziar and Martin, Manuel Montesino-San and Watine, Marc and Requeima, James and Gorroño, Javier and Randles, Cynthia and Mokalled, Tharwat and Guanter, Luis and Turner, Richard E. and Cifarelli, Claudio and Caltagirone, Manfredi},
+    url = {http://arxiv.org/abs/2511.21777},
+    doi = {10.48550/arXiv.2511.21777},
+    month = nov,
+    year = {2025}
+}
+```
+

marss2l-0.2.1/README.md

@@ -0,0 +1,204 @@
+[![MARS-S2L DOI:10.48550/arXiv.2511.21777](https://img.shields.io/badge/MARSS2L%20DOI-10.48550%2FarXiv.2511.21777-blue)](https://doi.org/10.48550/arXiv.2511.21777) [![PyPI](https://img.shields.io/pypi/v/marss2l)](https://pypi.org/project/marss2l/) [![PyPI - License](https://img.shields.io/pypi/l/marss2l)](https://github.com/UNEP-IMEO-MARS/marss2l/blob/main/LICENSE) [![HF](https://img.shields.io/badge/%F0%9F%A4%97-Datasets-yellow)](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L) [![HF](https://img.shields.io/badge/%F0%9F%A4%97-Models-yellow)](https://huggingface.co/UNEP-IMEO/MARS-S2L)
+
+# <img src="./notebooks/logo.png" alt="Logo" width='7%'> MARS-S2L
+
+This package contains the operational UNEP International Methane Emissions Observatory (IMEO) pipeline for methane plume detection, segmentation, and quantification in Sentinel-2 and Landsat satellite imagery. The methods and models implemented in this package are described in:
+
+> Allen, Mateo-García, Irakulis-Loitxate et al., *Artificial intelligence for methane detection: from continuous monitoring to verified mitigation* [10.48550/arXiv.2511.21777](https://arxiv.org/abs/2511.21777)
+
+### Licence
+
+The MARS-S2L database and all trained models are released under a [Creative Commons Non-Commercial Share-Alike licence](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt). The code in this package is published under a [GNU Lesser GPL v3 licence](https://www.gnu.org/licenses/lgpl-3.0.en.html).
+
+## Install
+
+Create the `marss2lpy312` virtual environment with conda:
+
+```bash
+conda env create -f environment/conda_vm.yaml
+```
+
+Install `marss2l` package:
+
+```bash
+pip install marss2l
+```
+
+## *End-to-end* inference [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/UNEP-IMEO-MARS/marss2l/blob/main/notebooks/examples/download_and_inference.ipynb)
+
+[This tutorial](./notebooks/examples/download_and_inference.ipynb) demonstrates an *end-to-end* example of the UNEP IMEO pipeline for detecting methane plumes in Sentinel‑2 and Landsat imagery. It downloads, compute the multi-band, multi-pass (MBMP, [Irakullis‑Loitxate et al., 2022](https://doi.org/10.1021/acs.est.1c04873)) retrieval, run inference with the MARS-S2L model ([Allen et al., 2025](https://arxiv.org/abs/2511.21777)), quantify the retrieval ΔXCH₄ and estimate the flux rate of detected plumes ([Gorroño et al., 2023](https://amt.copernicus.org/articles/16/89/2023/)).
+
+**Important considerations:**
+
+- The MARS‑S2L model produce false positives.
+- Therefore any positive model output must be validated before its use. 
+- <u>**At UNEP IMEO, all plumes are manually validated by at least two independent remote sensing analysts before their publication.**</u>
+
+## Dataset [🤗](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L)
+
+The MARS-S2L database and all trained models are released under a [Creative Commons Non-Commercial Share-Alike licence](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt). 
+
+Currently the dataset is publicly available in this Hugging-Face🤗 repo: [UNEP-IMEO/MARS-S2L](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L).
+
+To download the entire dataset and trained models (~100GB) run:
+
+```bash
+hf download --local-dir /path/to/localdir/MARS-S2L \
+            --repo-type dataset UNEP-IMEO/MARS-S2L
+```
+
+The following notebooks show how to load and plot images using the `torch.Dataset` directly from the Hugging Face repository: [`notebooks/examples/plot_images_dataset_train.ipynb`](./notebooks/examples/plot_images_dataset_train.ipynb) and [`notebooks/examples/plot_plumes_dataset_test.ipynb`](./notebooks/examples/plot_plumes_dataset_test.ipynb).
+
+## Retrain the MARS-S2L model
+
+We trained the model on a A100 GPU with 80Gb RAM. In order to re-train the proposed model and the baseline run:
+
+```bash
+wandb init # select the wandb project to display the training metrics
+python -m marss2l.reproduce_training --csv_path /path/to/dataset/validated_images_all.csv\
+                                     --batch_size 128 --num_workers 16 --num_workers_val 8\
+                                     --batch_size_val 256 --n_samples_per_epoch_train 65536\
+                                     --basename_dir train_logs # Where to store the training outputs
+```
+
+This code will train 4 models the proposed MARS-S2L model and the CH4Net model both trained on the train split of the dataset. In addition it will evaluate these models in the test split of the dataset. After the training the content of the `--basename_dir` folder should be:
+
+```
+train_logs/
+├── marss2l
+│   ├── best_epoch
+│   ├── config_experiment.json
+│   └── preds_test_2023.csv
+├── ch4net
+│   ├── best_epoch
+│   ├── config_experiment.json
+│   └── preds_test_2023.csv
+├── ch4net_sim
+│   ├── best_epoch
+│   ├── config_experiment.json
+│   └── preds_test_2023.csv
+└── marss2l_nosim
+    ├── best_epoch
+    ├── config_experiment.json
+    └── preds_test_2023.csv
+
+```
+
+Where:
+* `best_epoch` are the weights of the trained model
+* `config_experiment.json` is the metadata with the configuration of the experiment
+* `preds_test_2023.csv` are the model predictions for all entries in the test set
+
+
+## Reproduce the figures
+
+In the folder `notebooks/figures` there is the code to reproduce most of the figures of the paper. These notebooks read the data directly from the Hugging Face repository. See [this README](./notebooks/figures/README.md).
+
+## Load and eval trained models
+
+The MARS-S2L model of the paper is stored in this [Hugging-Face🤗 repository](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L) in the *trained_models* folder. The files are stored following the same naming convention as described above.
+
+In order to re-run the evaluation in the test set with the trained model proposed see [this README](./notebooks/figures/README.md).
+
+## Dataset structure
+
+The file [`validated_images_all.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_all.csv) contains the metadata of all the items in the dataset. Each item comprises a Sentinel-2 or Landsat image of 200x200 pixels
+together with its concatenated background image and the cloud mask. The methane enhancement image (ΔXCH₄) in ppb is also provided for positive samples. For positive samples, a vector multipolygon with the extent of the plume in WKT format is provided. In addition, each item
+includes several metadata described in the next section. (*Images metadata description*).
+
+The file [`validated_images_plumes.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_plumes.csv) contains all validated plumes in the dataset. Notice that there are few images that contain more than one plume. 
+The content of this file is described in the *Plumes metadata description* section.
+
+### Images metadata description
+
+Column description of file [`validated_images_all.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_all.csv):
+
+| Name      | Description      | Example | 
+| ------------- | ------------- | -------- |
+|s2path| Path to S2 or Landsat image concatenated with the background image. S2 L1C image with bands: B02, B03, B04, B08, B11, B12. Landsat TOA reflectance image with bands  B02, B03, B04, B05, B06, B07 | data/train_2023/43/b82be820-fe9c-411a-af20-82cf162760a7_ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0_s2.tif |
+|cloudmaskpath| Path to cloud mask generated with CloudSEN12 with interpretation `{0 : "clear", 1: "Thick cloud", 2: "Thin cloud", 3: "Cloud shadow"}` | data/train_2023/43/b82be820-fe9c-411a-af20-82cf162760a7_ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0_cloudmask.tif |
+|ch4path| Path to the ΔXCH₄ enhancement image in ppb. Only provided for positive samples (`isplume` `True`). | data/train_2023/43/b82be820-fe9c-411a-af20-82cf162760a7_ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0_ch4.tif |
+|wind_u| U component of the wind at 10m | -1.87 |
+|wind_v| V component of the wind at 10m | 3.76 |
+|wind_source| Source where the wind data is downloaded from. | ECMWF/ERA5_LAND/HOURLY |
+|vza| Viewing zenith angle. | 5.40 |
+|sza| Solar zenith angle. | 16.32 |
+|percentage_clear| Percentage of pixels clear according to CloudSEN12 mask. | 100.0 |
+|tile| Name of the S2 or Landsat product | S2A_MSIL1C_20240613T100031_N0510_R122_T32RNS_20240613T134114 or LC08_L1TP_192040_20190601_20200828_02_T1 |
+|isplume| Whether there is a methane plume on the image or not | True |
+|ch4_fluxrate| Flux rate in kg/h if there is a plume in the tile. | 7756.50 |
+|ch4_fluxrate_std| Standard deviation of the fluxrate. | 2941.19 |
+|satellite| Name of the satellite | S2A, S2B, LC08 or LC09 |
+|tile_date| Date of acquisition | 2024-06-13 10:00:31+00:00 |
+|notified| If the image contains a plume, whether the plume was notified or not | False |
+|id_location| UUID of the site | b82be820-fe9c-411a-af20-82cf162760a7 |
+|last_update| Last time this registry was modified | 2025-05-20 10:00:31+00:00 |
+|location_name| Code of the location. | A_10 |
+|country| Country of the location | Algeria |
+|lon| Longitude of the center of the location | 9.783133 |
+|lat| Latitude of the center of the location | 28.087894 |
+|offshore| Whether the location is offshore or onshore. | False |
+|sector| Sector of the observation | Oil and Gas, Coal, Waste or Unknown |
+|observability| Given observability to the image. Clear and cloudy is computed automatically with the cloudmask (50% threshold). Additionally the analyst can change this category (e.g. if the cloudmask is not correct or if there're artifacts in the scene such as snow, smoke, shadows...). | clear, cloudy, bad_retrieval, smoke, shadow, snow, out_of_swath |
+|background_image_tile| Name of the S2 or Landsat product used as background. | S2A_MSIL1C_20240603T100031_N0510_R122_T32RNS_20240603T134002 |
+|crs| Coordinate reference system of the image | EPSG:32632 |
+|transform_a| Geotransform of the image | 10.0 |
+|transform_b| Geotransform of the image | 0.0 |
+|transform_c| Geotransform of the image | 575940.0 |
+|transform_d| Geotransform of the image | 0.0 |
+|transform_e| Geotransform of the image | -10.0 |
+|transform_f| Geotransform of the image | 3108180.0 |
+|width| Width of the image | 200 |
+|height| Height of the image | 200 |
+|window_row_off| Top left row of the location of the plume within the image (used for the simulation). | 0.0 |
+|window_col_off| Top left column of the location of the plume within the image (used for the simulation). | 62.0 |
+|window_height| Height in pixels of the plume within the image (used for the simulation). | 101.0 |
+|window_width| Width in pixels of the plume within the image (used for the simulation). | 46.0 |
+|id_loc_image| Id of the image | ea782bfb-21b6-46c5-a6ed-d3b8ef8815a0 |
+|plume| Vector WKT representation of the plume. | MULTIPOLYGON (((9.781389 28.090856, 9.781646 28.090288, 9.781861 28.089796, 9.781818 28.089134, 9.781989 28.088622, 9.782268 28.088187, 9.782633 28.087903, 9.783105 28.087865, 9.783362 28.088244, 9.783083 28.088774, 9.78304 28.089436, 9.783148 28.090061, 9.783384 28.090705, 9.783663 28.091424, 9.783856 28.092522, 9.783642 28.093299, 9.783234 28.093905, 9.783106 28.094794, 9.783041 28.095571, 9.782312 28.096195, 9.78154 28.096422, 9.780896 28.096934, 9.779888 28.097104, 9.779352 28.096915, 9.779759 28.096063, 9.780596 28.09523, 9.781132 28.094472, 9.780896 28.093867, 9.780896 28.09309, 9.781154 28.092314, 9.781239 28.091784, 9.781154 28.091292, 9.781389 28.090856))) |
+|footprint| Vector WKT representation of the footprint of the image | POLYGON ((9.772934575210368 28.09701036650939, 9.7728039936767 28.07877712456095, 9.793361656935707 28.07865982254285, 9.7934957112434 28.09689297500473, 9.772934575210368 28.09701036650939)) |
+|split_name| Name of the split the item belongs to. One of 'train_2023', 'test_2023',  'val_2023' or 'Not Used'  | 'train_2023' |
+|case_study | Case study area of the same. | Turkmenistan |
+
+### Plumes metadata description
+
+Column description of file [`validated_images_plumes.csv`](https://huggingface.co/datasets/UNEP-IMEO/MARS-S2L/blob/main/validated_images_plumes.csv).
+
+| Name      | Description      | Example | 
+| ------------- | ------------- | -------- |
+|id_plume | UUID of the plume | 652fd72a-4a24-4938-8646-84309f899914|
+|id_loc_image | UUID of its corresponding image | 37ecaefe-619e-4dc7-90f1-d57bd48dbf0f|
+|tile| Name of the S2 or Landsat product | S2A_MSIL1C_20240613T100031_N0510_R122_T32RNS_20240613T134114 or LC08_L1TP_192040_20190601_20200828_02_T1 |
+|tile_date| Date of acquisition | 2024-06-13 10:00:31+00:00 |
+|satellite| Name of the satellite | S2A, S2B, LC08 or LC09 |
+|lat | Latitude of the source of the plume | 28.088329877970512|
+|lon | Longitude of the source of the plume | 9.78350881586494|
+|ch4_fluxrate | Estimated flux rate of the plume in kg/h | 9639.58562343052|
+|ch4_fluxrate_std | Estimated std of the flux rate of the plume in kg/h | 3964.424919968837|
+|geometry | Plume shape | MULTIPOLYGON (((9.782459 28.090423, 9.782716 28.089211, 9.782802 28.088378, 9.783746 28.088151, 9.78396 28.089249, 9.784217 28.090953, 9.784475 28.092316, 9.784432 28.093528, 9.783788 28.095156, 9.782802 28.095383, 9.78293 28.09402, 9.782716 28.093339, 9.782201 28.092203, 9.782416 28.09118, 9.782459 28.090423)))|
+|last_update | Last time this registry was updated | 2025-05-19 05:30:16.151729+00:00|
+|window_row_off | Pixel upper left row coordinate within the image where the plume is located | 15|
+|window_col_off | Pixel upper left column coordinate within the image where the plume is located | 88|
+|window_height | Number of columns from the upper left coordinate | 82|
+|window_width | Number of rows from the upper left coordinate | 25|
+
+## Licence
+
+The MARS-S2L database, all trained models and tutorials are released under a [Creative Commons Non-Commercial Share-Alike licence](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt). 
+
+The code in this package is published under a [GNU Lesser GPL v3 licence](https://www.gnu.org/licenses/lgpl-3.0.en.html) <img src="https://www.gnu.org/graphics/lgplv3-88x31.png" alt="licence" width="80">.
+
+## Cite
+If you find this work useful, please cite:
+
+```bibtex
+@article{allen_2025,
+    title = {Artificial intelligence for methane detection: from continuous monitoring to verified mitigation},
+    author = {Allen, Anna and Mateo-Garcia, Gonzalo and Irakulis-Loitxate, Itziar and Martin, Manuel Montesino-San and Watine, Marc and Requeima, James and Gorroño, Javier and Randles, Cynthia and Mokalled, Tharwat and Guanter, Luis and Turner, Richard E. and Cifarelli, Claudio and Caltagirone, Manfredi},
+    url = {http://arxiv.org/abs/2511.21777},
+    doi = {10.48550/arXiv.2511.21777},
+    month = nov,
+    year = {2025}
+}
+```
+

marss2l-0.2.1/marss2l/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"