EO Time Series Viewer¶
The Earth Observation Time Series Viewer (EOTSV) is a free-and-open source QGIS Plugin to visualize and label raster-based earth observation time series data.

Online documentation |
|
Source Code |
|
Issue tracker |
Features¶
Raster images can be added to the time series without homogenisation of spatial extent or coordinate reference system. Time stamps are extracted automatically from (i) image meta data (“acquisition date”), (ii) the file name or (iii) the file directory path.
Raster IO uses the Geospatial Data Abstraction Library (GDAL), which supports up to 142 different raster formats.
Distinguished sensors by pixel size and number of bands and, if available, band wavelength information and sensor name.
Spatial-temporal (“maps”) visualisation allows to show multiples band combinations in parallel, e.g. True Color and coloured infrared.
Color stretches are applied to all raster images of same sensor and band combination. This helps to optimise color stretches for multiple images in a minimum of time.
Spectral-temporal (“time profile”) visualisation shows raw or scaled, sensor specific band values.
See also
Virtual Raster Builder - A QGIS Plugin to create Virtual Raster images.
EnMAP Box 3 - A QGIS Plugin to visualize and process Multi- and Hyperspectral raster images.
License and Use¶
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3 (GNU GPL-3) , as published by the Free Software Foundation. See also License.
Installation¶
Important
The EO TSV plugin requires QGIS Version 3.10 or higher
QGIS 3 Plugin Installation¶
Developers¶
Please follow http://enmap-box.readthedocs.io/en/latest/dev_section/dev_installation.html to set up your IDE for developing a QGIS python application and ensure that git and git-lfs is installed.
Clone the eo-time-series-viewer repository and checkout the development branch:
git clone https://bitbucket.org/jakimowb/eo-time-series-viewer.git git checkout develop git lfs checkout
Make the repository eo-time-series-viewer folder accessible to your python project
Call timeseriesviewer/main.py or the folliwing code to start the EO Time Series Viewer:
from timeseriesviewer.utils import initQgisApplication qgsApp = initQgisApplication() ts = TimeSeriesViewer(None) ts.run() qgsApp.exec_() qgsApp.exitQgis()
Todo
add detailed description how to setup an IDE to run the EO Time Series Viewer without QGIS
Quick Start¶
Click
in the QGIS Tool Bar or via to start the EO Time Series Viewer
Click
to load an exemplary time series of Landsat and RapidEye observations.Open the sensor panel
and change the sensor namesDefault
Changed
Landsat
RapidEye3
The change of sensor names becomes visible in other other parts of the GUI as well, e.g. the list of time series source images.
Use the scroll band and the map tools
to change the temporal and spatial subset shown from the time series.
Open the Mapping panel, change the map view name from Map View 1 to True Color and set the multiband color render band selection to RGB = 3-2-1 for both, Landsat and RapidEye images (right-click on layer,
).
Now we like to optimize the color stretch. Choose a -clouded Landsat observation like 2014-06-24 and use the map context menu (right-mouse-click) to click on
. Repeat with Linear and Gaussian stretch as well as for RapidEye images to see how this changes the band-specific min/max values in the Map View settings.Click
to create a second map view, respectively row of map images. Call it
Short-Wave IR
and the the multiband color render bands to Landsat RGB = 4-5-3 and RapidEye RGB = 5-4-3Expand the Map Properties combobox (in the Mapping panel), increase the map size to 300x300 pixel and press Apply.
Bring the Temporal Profile panel
and the 2D page to the front. Clickand select a map location to visualize the temporal profile for. Each selected map location will be listed in the panels
Coordinate page.
Go back to the 2D plot page and add a second profile with RapidEye data as Sensor source. Change the expression field to show the Normalized Difference Vegetation Index (NDVI) for both sensors:
Sensor
Expression NDVI
Landsat
(b4-b3)/(b4+b3)
RapidEye
(b5-b3)/(b5+b3)
Graphical User Interface¶

This is what the EO Time Series Viewer’s interface looks like when opening it.¶
Note
Just like in QGIS, many parts of the GUI are adjustable panels. You can arrange them as tabbed, stacked or separate windows. Activate/Deactivate panels under
Time Series¶
This window lists the individual input raster files of the time series.

Date corresponds to the image acquisition date as automatically derived by the EO TSV from the file name. Checking
or unchecking
the box in the date field will include or exclude the respective image from the display
Sensor shows the name of the sensor as defined in the Sensors / Products tab
ns: number of samples (pixels in x direction)
nl: number of lines (pixels in y direction)
nb: number of bands
image: path to the raster file
You can add new rasters to the time series by clicking Add image to time series.
Remove them by selecting the desired rows in the table (click on the row number) and pressing the
Remove image from time series button.
Tip
If you have your time series available as one large raster stack, you can import this file via
Tip
Click
to load a small example time series.Sensors / Products¶

The EO Time Series Viewer automatically assesses different characteristics of the input images (number of bands, geometric resolution etc.) and combines identical ones into sensor groups (or products). Those are listed as follows in the Sensor / Products window:
name
is automatically generated from the resolution and number of bands (e.g. 6bands@30.m). This field is adjustable, i.e. you can change the name by double-clicking into the field. The here defined name will be also displayed in the Map View and the Time Series table.nb
: number of bandsn images
: number of images within the time series attributed to the according sensorwl
: comma separated string of the (center) wavelength of every band and [unit]id
: string identifying number of bands, geometric resolution and wavelengths (primary for internal use)
Toolbar¶
Button |
Function |
---|---|
Add images to the time series |
|
Add Time Series from CSV |
|
Remove all images from Time Series |
|
Save Time Series as CSV file |
|
Add vector data file |
|
Synchronize with QGIS map canvas |
|
Add maps that show a specified band selection |
|
Refresh maps |
|
Pan map |
|
Zoom into map |
|
Zoom out |
|
Zoom to pixel scale |
|
Zoom to maximum extent of time series |
|
Center map on clicked locations |
|
Identify Pixels and Features |
|
Identify cursor location values |
|
Identify raster profiles to be shown in a Spectral Library |
|
Identify pixel time series for specific coordinate |
|
Select Features |
|
Start Editing Mode |
|
Save Edits |
|
Draw a new Feature |
Note
Only after Identify Pixels and Features is activated you can select the other identify tools
(
,
,
). You can activate them all at once as well as of them,
in case of the latter variant clicking in the map has no direct effect (other than moving the crosshair, when activated)
Map Visualization¶
Map Properties¶
In the map properties box you can specify Width and Height, as well as background Color and the CRS of the single map canvases.
Click Apply to apply changes. By default the keep ratio option is checked, i.e. height will be the same as width. In case
you want to have unequally sized views, deactivate this option.

Map Views¶
A map view is a row of map canvases that show the time series images of different sensors/product in the same band combination, e.g. as “True Color bands”. The map view panel allows to add or remove map views and to specifiy how the images of each sensor are to be rendered.
You can add new Map Views using the
button. This will create a new row of map canvases. Remove a map view with the
button.
In case the Map View does not refresh correctly, you can ‘force’ the refresh using the
button (which will also apply all the render settings).
Access the settings for individual Map Views by clicking in the mapview
You can use the
button to highlight the current Map View selected in the dropdown menu (respective image chips will show red margin for a few seconds).
For every Map View you can alter the following settings:
Hide/Unhide the Map View via the
Toggle visibility of this map view button.
Activate/Deactivate Crosshair via the
Show/hide a crosshair button. Press the arrow button next to it to enter the Crosshair specifications
, where you can customize e.g. color, opacity, thickness, size and further options.
You may rename the Map View by altering the text in the Name field.
Layer representation:
Similar to QGIS you can change the visual representation of raster or vector layers in the layer properties. To open them, right-click on the layer you want to alter and select
Cursor Location Values¶
This tools lets you inspect the values of a layer or multiple layers at the location where you click in the map view. To select a location (e.g. pixel or feature)
use the Select Cursor Location button and click somewhere in the map view.
The Cursor Location Value panel should open automatically and list the information for a selected location. The layers will be listed in the order they appear in the Map View. In case you do not see the panel, you can open it via
.By default, raster layer information will only be shown for the bands which are mapped to RGB. If you want to view all bands, change the Visible setting to All (right dropdown menu). Also, the first information is always the pixel coordinate (column, row).
You can select whether location information should be gathered for All layers or only the Top layer. You can further define whether you want to consider Raster and Vector layers, or Vector only and Raster only, respectively.
Coordinates of the selected location are shown in the x and y fields. You may change the coordinate system of the displayed coordinates via the
Select CRS button (e.g. for switching to lat/long coordinates).
Profile Visualization¶

Example: Temporal NDSI (Normalized Difference Snow Index) profile for 2 locations using Landsat 7 and 8 images.¶
Temporal Profiles¶
The Temporal Profiles panel lets you visualize temporal profiles.
On the left side you can switch between the profile and the coordinates
page. The latter
lists all coordinates of selected or imported profile locations.
- Adding and managing a temporal profile:
You can use the
button to click on a location on the map an retrieve the temporal profile, or in the toolbar select
+
.
Mind how the selected pixel now also appears on the coordinates
page!
If you select further pixels (
), they will be listed in the coordinates page, but not automatically visualized in the plot.
Use
to create an additional plot layer, and double-click in the Coordinate field in order to select the desired location (so e.g. the newly chosen pixel) or just change the location in the current plot layer.
Similarly, you can change the sensor to be visualized by double-clicking inside the Sensor field and choosing from the dropdown.
Click inside the Style field to change the visual representation of your time series in the plot.
Remove a time series profile by selecting the desired row(s) and click
.
The DN or Index field depicts which values will be plotted.
Here you may select single bands (e.g.
b1
for the first band)or you can calculate indices on-the-fly: e.g. for the Landsat images in the example dataset the expression
(b4-b3)/(b4+b3)
would return the NDVI.Example of visualizing the NDVI for the same location for different sensors (example dataset).¶
You can also move the map views to a desired date from the plot directly by right-click into plot
- Importing or exporting locations:
Spectral Profiles¶
The spectral library view allows you to visualize, label and export spectral profiles.

Use the
Select a spectrum from a map button to extract and visualize a pixels profile (by clicking on a pixel on the map).
You can add a selected spectrum to your spectral library by clicking on
.
The gathered spectra are listed in the table on the right. For every spectrum additional metadata will be stored, e.g. the date, day of year and sensor.
When the
button is activated, the profile will be directly added to the library after clicking on a pixel.
Change the display style (color, shape, linetype) in the Spectral Library Properties, which can be accessed via the
button in the lower right.
Note
- The spectral library table behaves quite similar to the attribute table you know from QGIS:
Quick Labeling¶
The EO Time Series Viewer assists you in describing, i.e. label reference data, e.g. by describing vector geometries with a related land cover type or observed events. Whether your locations (point, lines or polygons) of interest already exist, or need to be digitized on the visualized maps, in both cases you want to describe them in the attribute table of the vector layer.
The EO Time Series Viewer supports this with “Quick Label” short-cuts from the map context menu. If triggered, they send temporal or categorical information direct to the attribute cells of selected geometries, e.g a polygon that has been selected in a map.

Let’s assume we have a map related to a Landsat (LND) observation taken at 2019-02-05T11:23:42.00. The following table shows how this is translated into linked vector fields:
Type of linked vector layer field |
||||||||
---|---|---|---|---|---|---|---|---|
LabelType |
varchar |
int |
double |
datetime |
date |
time |
bool |
blob |
Date |
2019-02-05 |
2019-02-05T00:00:00 |
2019-02-05 |
|||||
Date-Time |
2019-02-05T11:23:42 |
2019-02-05T11:23:42 |
2019-02-05 |
|||||
Time |
11:23:42 |
2019-02-05T11:23:42 |
11:23:42 |
|||||
Day of Year (DOY) |
36 |
36 |
36 |
|||||
Year |
2019 |
2019 |
2019-02-05T11:23:42 |
2019-02-05 |
11:23:42 |
|||
Decimal Year |
2019.0980926430518 |
2019 |
2019.098 |
|||||
Sensor Name |
LND |
|||||||
Source Image |
/path/to/image |
To use Quick Labels, open the vector layer properties and activate them in the Attribute Form widget:

Shortcuts¶
Key |
Action |
---|---|
F1/ALT+F1 |
set map center from/to QGIS map canvas |
F2/ALT+F2 |
set map extent from/to QGIS map canvas |
ArrowLeft/Right |
move map visualization forward / backward by one date |
ArrowLeft/Right+CTRL A/D |
move map visualization forward / backward by number of visible map dates |
End / Pos1 |
move map visualization to end / start of time series |
ArrowDown/Up S/W |
select next / previous vector feature in active attribute table |
Next/Previous Page |
show next / previous map view | e.g toggle between a True Color and a Infrared view |
Changelog¶
2023-04-07 (version 1.18)¶
Stability Update
removed several issues related to updates in QGIS and GDAL
updated QPS library, which introduces several updates to the SpectralLibrary handling
2021-03-10 (version 1.17)¶
quick raster band selection and GDAL Metadata panel now appear in QGIS layer properties dialog
fixed smaller issues related to plugin loading and unloading
added bulk loading from time series definition files
fixes to run with QGIS 3.18+
move to next/previous observation with arrow right/left
move to next/previous observation window with CTRL + arrow right/left or A/D
move to last/first observation with End/Pos1 or ALT + A/D
select next/previous vector feature with arrow downs/up or S/W
added option for exclusive visibility of map views
show next/previous map view with PageDown/PageUp or ALT + S/W
set map center from/to QGIS with F1/ALT+F1
set map extent from/to QGIS with F2/ALT+F2
modified observation slider, slider shows range of visible dates
2021-02-02 (version 1.16)¶
fixed smaller issues
forward / backward button to move in time now shifts by number of opened observation dates/maps
next / previous feature button offers to (i) move to the next feature and (ii) update the map dates according to the availability of raster sources for the new map extent
faster updates of observation data visibility
2020-11-23 (version 1.15)¶
source files can be opened by drag and drop to the time series tree view
maps can be organized in multiple rows per map view (rows x columns)
map descriptions can be defined with QgsExpressions, e.g. ‘@map_date’ to show the date
quick labels: CTRL + right mouse button opens map menu even when the feature modify map tool is activates
source visibility update can be run on entire time series or (new and faster) for the next time steps only
added “follow current date” option to time series table to keep focus on the map window date range
added wildcard + regular expression filter to time series table
smaller bug fixes and improvements
2020-11-06 (version 1.14)¶
this version focuses on stability updates and improvements of the “quick label” system
map canvas menu now available with standard map tool (like zoom tool)
introduces label groups to apply quick labeling short cuts on different sets of vector fields
attribute table allow to selected added features automatically
optimized package imports
improved SpectralLibrary tool
fixed bugs
2020-07-23 (version 1.13)¶
time series and map settings can be stored to and reloaded from QGIS Projects
refactored layer styling and default raster stretching
fixed CRS translation bug and other smaller bugs
quick labels can be used to write date / datetime data into vector fields of type QDate or QDateTime
refactored context menus, e.g. in map view layer tree view, fixed #106
2020-04-09 (version 1.12)¶
TimeSeries tree view allows to change the visibility of single source images, e.g. to hide clouded observations
several updates to the Spectral Library Widget, e.g. import / export of profiles from ASD, ARTMO, EcoSYS or SPECCHIO
EOTSV allows to open images from sources with subdatasets, e.g. from Sentinel-2 or HDF images.
2020-01-23 (version 1.11)¶
revised unit tests for CI pipelines
fixed smaller issues in SensorModel
fixed #103: EOTSV crashed on Linux, caused by an attempt to storing a unpickable QgsTextFormat to QSettings
2019-11-25 (version 1.10)¶
improved matching of source images to sensors: matching can be specified in the settings dialog. Sensor matching based on ground sampling distance + number of bands + data type and optionally wavelength and/or sensor name
settings dialog shows known sensor / product specification and allows to modify their default “sensor name”
fixed copying of layer styles to maps of same sensor and map view type
improved speed of mapping and layer buffering
failed image sources are logged in the EO Time Series Viewer log panel
Spectral Library Viewer better handles large collections of spectral profiles
2019-10-02 (version 1.9)¶
includes several smaller updates
fixed error ‘shortcutVisibleInContextMenu’ error that occurred with Qt < 5.10
enhanced wavelength extraction from GDAL metadata: wavelength can be specified per band
2019-09-19 (version 1.8)¶
updated spectral library module
fixed #104: error in case of wrong spatial extent
default CRS properly shown in map view settings
user-defined CRS visible
2019-08-06 (version 1.7)¶
increased contrast for default map view text
improved reading of wavelength information, e.g. from Pleiades, Sentinel-2 and RapidEye data
temporal profile plot: data gaps can be shown by breaks in the profile line, data source information is correctly shown for selected points only
current extent can be copied via MapCanvas context menu
fixed #102: move maps to date of interest selected in a temporal profile plot
2019-07-16 (version 1.6)¶
re-design of map visualization: faster and more compact, the number of maps is fixed to n dates x m map views
date, sensor or map view information can be plotted within each map and become available in screenshots
releases map layers that are not required any more
slider + buttons to navigate over time series
fixed preview in crosshair dialog
2019-07-07 (version 1.5)¶
closing the EO Time Series Viewer instance will release all of its resources
added “Lock Map Panel” to avoid unwanted resizing of central widget
fixed missing updates of time series tree view when adding / removing source images
map canvas context menu lists layers with spatial extent intersecting the cursor position only
fixes feature selection error
added quick label source image to label the path of raster layer
2019-07-02 (version 1.4)¶
adding vector layers with sublayers will add all sublayers
map canvas context menu “Focus on Spatial Extent” will hide maps without time series data for the current spatial extent
labeling dock allows to iterate over vector features. the spatial map extent will be centered to each feature (#26)
added several convenience function to TimeSeriesViewer object
fixed a bug that did not allow to create new polygon features
temporal profile visualization: fixed icons to preview selected plot style, coordinate described by “
”, e.g. “42 Deforested”, fixed plot style preview updated SpectralLibraryViewer
fixed spelling error in stacked band input dialog
MapViews can add raster layers that have been opened in QGIS, e.g. XYZ Tile with OpenStreetMap data
2019-06-12 (version 1.3)¶
fixed #99: opening example closes QGIS on linux
fixed #96 and #99 : docutils not installed error when showing rst/md content
fixed #97: TSV does not start (Linux)
2019-05-31 (version 1.2)¶
added SaveAllMapsDialog and menu option to export all maps as image files.
fixed #91: select Temporal Profile / Spectral Profile button activates the required map tools.
fixed #92: map canvas context menu “copy to clipboard” options.
2019-05-24 (version 1.1)¶
dates and data sources of the TimeSeries are now shown in a TreeView instead TableView
observation dates of current visible map canvases are highlighted in the time series tree view
sensor raster layer properties can be opened from MapView layer tree #87. Stats will be related to center mapcanvas.
fixed: StackedInputDialog, MapCanvas context menu, “Save Changes?” labeling dialog (#85), remove temporal profile (#86), draw new feature error (#84), Crosshair button status (#90), and some more
2019-05-15 (version 1.0, major update)¶
labeling tools to modify vector layers.
quick labeling for time-labels information
synchronization with QGIS Map canvas center
SpectralLibrary can import SpectralProfiles from a raster image based on vector positions
simplified MapView control dock, each MapView has it’s own layer tree.
improved MapTool organization
removed PyQtGraph from list of required external python packages
2019-03-29¶
renamed plugin folder from “timeseriesviewerplugin” to “EOTimeSeriesViewer”.
improved SpectraLibrary tool
CI tests with bitbucket pipelines
several bug fixes
2019-03-01 (version 0.8)¶
added labeling panel
scheduled map canvas refreshes
multiple images per observationdata & sensor
fixed several bugs
2018-11-13¶
fixed bugs which where caused by CRS changes
fixed macOS QGIS (3.4.1.) crashes caused by QgsMapCanvas constructor
2018-11-09¶
uses QgsTaskManager for background loading
own QgsMapLayerStore to not mix-up with (main) QGIS layers
fixed bugs related to changes in QGIS API
2018-06-20 (version 0.7)¶
Visualization of images with stacked temporal information (each band = one observation date)
some bugfixes
2018-06-12¶
Speclib I/O as CSV or ENVI-Spectral Library + CSV table for attributes
temporary VRTs now created in-memory (gdal VSI mechanism) instead in a disk temp path
Spectral Library: profile coordinate now in center of map pixel (issue #66)
Save map canvas to clipboard
Width of plot lines now scale-independent (issue #64, QPen.setCosmetic(True))
adding fields to spectral library (issue #61)
2018-06-04 (version 0.6)¶
SpectralLibrary Module * now based on in-memory QgsVectorLayer * Locations and values of spectral profile can be exported as vector data set * Locations of spectral profiles can be rendered on MapCanvases
Temporal Profile Module * now based on in-memory QgsVectorLayer * Locations of temporal profiles can be exported as vector data set * Band values of temporal profiles can be exported as CSV file * Locations of temporal profiles can be rendered on MapCanvases
2018-04-17 (version 0.5)¶
ported to QGIS 3, Qt5 and Python 3.6
improvements in temporal profile visualization
removed several bug
visibility of vector and raster layers can be toggled per map view
improved interaction between QGIS and EOTSV (Buttons to import/export spatial extent of map canvas or center)
2018-03-29¶
improved definition of individual 2D / 3D charts per sensor & pixel-location
added based OpenGL based 3D plot features (axis, grids, labels)
changed name to “EO Time Series Viewer” (EOTSV)
2018-02-11¶
merged updates to temporal profile visualization, e.g. save temporal profiles, compare 2D profiles between different location, experimental 3D visualization
2018-01-31¶
added file filters for OpenFileDialog
2018-01-19¶
initialized Sphinx-based documentation
improved map visualization + map settings
2017-05-21¶
many changes, done in development branch “develop”,
e.g: QGIS MapCanvases for interactive maps, temporal profiles, …
2017-02-14¶
first setup for test users in the recent development branch
Gallery¶
This section gives you a visual glimpse at the functionalities of the Time Series Viewer plugin
Multiple Map Views¶

Visualize a time series in several map views, for example to show a different band combination or highlight additional layers¶
Temporal plots¶

Visualize temporal profiles at selected (in the map canvas) or imported (from a shapefile) locations and transform the values on-the-fly for plotting¶
Spectral plots¶

Visualize and manage spectral profiles in a comprehensive spectral library tool¶
Labeling¶

Label your time series using a vector dataset and interactively zoom/pan to selected features in the map canvas¶
Image crosshair¶

Detailed and fully customizable crosshair with pixel highlighting and scale bar¶
GNU GENERAL PUBLIC LICENSE¶
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. http://fsf.org/
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble¶
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS¶
0. Definitions.¶
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
1. Source Code.¶
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
2. Basic Permissions.¶
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
3. Protecting Users’ Legal Rights From Anti-Circumvention Law.¶
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
4. Conveying Verbatim Copies.¶
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.¶
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
6. Conveying Non-Source Forms.¶
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
7. Additional Terms.¶
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
8. Termination.¶
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
9. Acceptance Not Required for Having Copies.¶
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.¶
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
11. Patents.¶
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
12. No Surrender of Others’ Freedom.¶
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.¶
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
14. Revised Versions of this License.¶
The Free Software Foundation may publish revised and/or new versions of the GNU 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 Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
15. Disclaimer of Warranty.¶
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.¶
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.¶
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs¶
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w`.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c` for details.
The hypothetical commands `show w’ and `show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.