Welcome to Pyplis

Official website of Pyplis, a Python software containing algorithms and analysis routines for UV SO2 camera data. Apart from the API documentation, this website includes additional relevant information about the software (e.g. installation details, access of example data) as well as useful practical information that helps getting started with Pyplis.

A paper introducing the software is published in the Journal Geosciences (MDPI). If you find Pyplis useful for your analysis, we highly appreciate if you acknowledge our work by citing the paper.

Screenshot of the Pyplis paper. Please acknowledge our work by citing the paper.

The software can be downloaded from the Github page or installed via PyPi using:

pip install pyplis

from the command line.

Calibrated SO2 column density image showing 2 plume cross section lines and the position of the FOV of a co-located DOAS instrument.

Click here to see a video showing an animation of Mt. Etna SO2 emissions recorded on 16/09/2015

Contents:

• Introduction
  • Help needed / Contributions more than welcome
  • Code documentation and more
  • Main features
  • Installation instructions and Requirements
    • Comment regarding conda environments
    • Installation using conda
    • Requirements
    • Installation of the requirements
    • Installation of pyplis
    • Installation remarks and known issues
  • Getting started
  • Example and test data
    • Note
  • Scientific background
    • Citation
  • Copyright
  • Visualisation of API architecture
    • Flowchart emission-rate retrieval (scientific)
    • Flowchart API (code architecture)
• Plot gallery
• Primer on data import
  • Data import - Specifying custom camera information
    • Specifying your file naming convention
    • The ECII camera standard
• Example scripts
  • Introductory scripts
    • Example 0.1 - Image representation
    • Example 0.2 - The camera class
    • Example 0.3 - Introduction into ImgList objects
    • Example 0.4 - Introduction into the Dataset class
    • Example 0.5 - Optical flow live view
    • Example 0.6 - Plume cross section lines
    • Example 0.7 - Manual cell calibration
  • Examples for emission rate analysis
    • Example 1 - Creation of analysis setup and Dataset
    • Example 2 - Measurement Geometry
    • Example 3 - Plume background analysis
    • Example 4 - Preparation of AA image list
    • Example 5 - Automatic cell calibration
    • Example 6 - DOAS calibration
    • Example 7 - AA sensitivity correction masks
    • Example 8 - Plume velocity retrieval (Cross correlation)
    • Example 9 - Plume velocity retrieval (Optical flow Farneback)
    • Example 10 - Import plume background images
    • Example 11 - Image based signal dilution correction
    • Example 12 - Emission rate analysis (Etna example data)
• API
  • Setup classes
  • Data Set object
  • Geometrical calculations
  • Image base module
  • Image list objects
  • Plume background analysis
  • Plume velocity analysis
  • Camera calibration base class
  • Cell calibration
  • DOAS calibration
  • Emission rate retrieval
  • Signal dilution correction
  • Low level utils
  • Further processing classes
  • Fitting / Optimisation algorithms
  • Mathematical model functions
  • I/O routines
  • Custom image import methods
  • Helper functions
  • Forms and geometrical objects
• Supplementary material
  • Poster EGU General Assembly, Vienna 2017
• Changelog
  • Release 1.3.0 -> 1.4.3
  • Release 1.0.0 -> 1.0.1
    • 25/11/2017 - 12/01/2018 (v1.0.0 -> v1.0.1)
  • Release 1.0.1 -> 1.3.0
    • Summary
    • 1.0.1 -> 1.1.0
    • 1.1.0 -> 1.2.1
    • 1.2.1 -> 1.3.0
  • Release 0.11.2 -> 1.0.0
    • 30-31/03/2017
    • 01-07/04/2017
    • 10/04/2017
    • 11/04/2017
    • 12/04 - 04/05/2017
    • 04/05 - 21/05/2017 (v0.11.4 -> v0.12.0)
    • 22/05 - 29/08/2017 (v0.11.4 -> v0.12.0)
    • 30/08 - 05/10/2017 (v0.12.0 -> v0.13.4)
    • 5/10/2017 - 25/11/2017 (v0.13.4 -> v1.0.0)
  • Release 0.9.2 -> 0.11.2
    • 28/02/2017 - 01/03/2017
    • 02/03/2017
    • 03/03/2017
    • 05/03/2017
    • 06/03/2017
    • 07/03/2017
    • 08/03/2017
    • 09/03/2017
    • 13/03/2017
    • 14/03/2017
    • 15/03/2017
    • 16/03/2017 - 20/03/2017
    • 22/03/2017
    • 23/03/2017
    • 24/03/2017
    • 28-29/03/2017

Indices and tables

• Index
• Module Index
• Search Page