Skip to main content

TICOI

Language Python test License Hatch project Ruff

TICOI is a tool to postprocess surface velocities estimated from remote sensing images (e.g., over glaciers, ice-sheets, landslides or earthquakes). The method is based on the temporal closure principle. It fuses velocity measurements which are multi-temporal (with different temporal baselines) and multi-sensor (from different satellite images), and may have been computed by different processing chains. It takes as input NetCDF files containing the image-pair velocities, that you may have generated yourself. It also natively supports data from the NASA ITS_LIVE project or from Millan et al. (2022).

The package is based on the methodological developments published in:

  • Charrier, L., Dehecq, A., Guo, L., Brun, F., Millan, R., Lioret, N., Copland, L., Maier, N., Dow, C., and Halas, P.: TICOI: an operational Python package to generate regular glacier velocity time series, The Cryosphere, 19, 4555–4583, https://doi.org/10.5194/tc-19-4555-2025, 2025.

  • Charrier, L., Yan, Y., Koeniguer, E. C., Leinss, S., & Trouvé, E "Extraction of Velocity Time Series With an Optimal Temporal Sampling From Displacement Observation Networks," in IEEE Transactions on Geoscience and Remote Sensing, vol. 60, pp. 1-10, 2022, Art no. 4302810, doi: 10.1109/TGRS.2021.3128289.

The main principle of TICOI relies on the temporal closure of the displacement measurement network. Measured displacements with different temporal baselines are expressed as linear combinations of estimated displacement (see the Figure below). The aim is to take advantage of different types of information (displacement measured using different temporal baselines, on images from different types of satellite, using different processing chains) to extract glacier velocity time series, with a given temporal sampling. This enable the harmonization of various datasets, and the creation of standardized sub-annual velocity products.

Temporal_closure

INSTALLATION

With pip

pip install ticoi

With git clone and mamba

This option allow you to modify the code Clone the git repo and create a mamba environment (see how to install mamba in the mamba documentation):

git clone https://github.com/ticoi/ticoi.git
cd ticoi
mamba env create -f environment.yml -n ticoi_env  # change the name if you want
mamba activate ticoi_env  # Or any other name specified above
pip install -e . #to use the package everywhere locally

TUTORIALS

Basic examples

notebook

python_script

Advanced examples

TICOI processing

Choice of hyperparameters

Criterion to evaluate the quality of TICOI results

TO USE YOUR OWN DATASET

You have geotiff files

You need to convert them into netcdf, by modifying this script.

You have netcdf files

If it is ITS_LIVE data, or Millan et al., 2022, you can directly use them! If not, there are two options:

  • you can modify your variables to match TICOI compatible format. For that, your dimensions need to be ("mid_date", "y", "x"), with "mid_date" your time dimension. Your variables need to be:
    • vx, vy (necessary): velocities along your x and y axis in m/y
    • date1, date2 (necessary): first and second date of acquisition of the image-pair
    • errorx, errory (optional): errors along your x and y axis in m/y Your attributes:
    • author (optional): if you want to specify the name of the author
    • source (optional): if you want to specify the source of the dataset
  • you can directly add your own data loader to convert your format in TICOI format, inside the TICOI package. For that see an example here

HYPERPARAMETERS AND OUTPUTS

TO CONTRIBUTE

We welcome any contribution to this package! See guidelines here.

CITATION

If you use this package, please cite:

Charrier, L., Dehecq, A., Guo, L., Brun, F., Millan, R., Lioret, N., Copland, L., Maier, N., Dow, C., and Halas, P.: TICOI: an operational Python package to generate regular glacier velocity time series, The Cryosphere, 19, 4555–4583, https://doi.org/10.5194/tc-19-4555-2025, 2025.

Metadata

Release files for ticoi 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ticoi 0.1.2
File Size Uploaded Provenance Actions
ticoi-0.1.2.tar.gz 977.3 kB Without provenance Details for ticoi-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ticoi 0.1.2
File Interpreter ABI Platform Actions
ticoi-0.1.2-py3-none-any.whl Python 3 none any Details for ticoi-0.1.2-py3-none-any.whl

Total release size: 1.1 MB

Release files / ticoi-0.1.2.tar.gz

Download URL ticoi-0.1.2.tar.gz
Size 977.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d131450c53aef0c33b2c5c29aa89e6b538ceabccd97e887e96532826daf99263
BLAKE2b-256 checksum
How to use checksums
f70db8ca9257961b51d94441d99dc656b51a1141552ed9befede599e14418442
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.3 cpython/3.10.19 HTTPX/0.28.1

Release files / ticoi-0.1.2-py3-none-any.whl

Download URL ticoi-0.1.2-py3-none-any.whl
Size 104.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f5c982aa0564c0145440c9b2846f15196295124bd53c85109b42d0441243c6c6
BLAKE2b-256 checksum
How to use checksums
6baa040179b8d06b1ee4f7819e533a60a589169a3ac3f67870c61b53c6c931f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.3 cpython/3.10.19 HTTPX/0.28.1

Security for ticoi 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page