ticoi 0.0.1__py3-none-any.whl

ticoi-0.0.1.dist-info/METADATA

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: ticoi
+Version: 0.0.1
+Summary: A package to run Temporal Inversion using linear Combinations of Observations, and Interpolation (TICOI)
+Project-URL: Homepage, https://github.com/ticoi/ticoi.git
+Project-URL: Issues, https://github.com/pypa/sampleproject/issues
+Author: Lei Guo
+Author-email: Laurane Charrier <laurane.charrier@outlook.com>
+License: GPL-3.0-only
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: aiohttp
+Requires-Dist: dask
+Requires-Dist: geopandas
+Requires-Dist: h5netcdf
+Requires-Dist: jdcal
+Requires-Dist: joblib
+Requires-Dist: matplotlib
+Requires-Dist: notebook
+Requires-Dist: numba
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pyproj
+Requires-Dist: rasterio
+Requires-Dist: requests
+Requires-Dist: rioxarray
+Requires-Dist: scikit-learn
+Requires-Dist: scipy
+Requires-Dist: seaborn
+Requires-Dist: shapely
+Requires-Dist: statsmodels
+Requires-Dist: tqdm
+Requires-Dist: xarray
+Requires-Dist: zarr
+Description-Content-Type: text/markdown
+
+# TICOI
+
+[![Language](https://img.shields.io/badge/python-3.10%2B-blue.svg?style=flat-square)](https://www.python.org/)
+[![Python test](https://github.com/ticoi/ticoi/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/ticoi/ticoi/actions/workflows/python-app.yml)
+[![License](https://img.shields.io/badge/license-GPLv3+-blue.svg?style=flat-square)](https://github.com/ticoi/ticoi/blob/main/LICENSE)
+[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+TICOI is a tool to postprocess surface velocity time series estimated from remote sensing (e.g., ice flow, landslides).
+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, or natively supports data from the [NASA ITS_LIVE project](https://its-live.jpl.nasa.gov/) or from
+[Millan et al. (2022)](https://www.theia-land.fr/en/blog/product/glacier-surface-flow-velocity/).
+
+The package is based on the methodological developments published in:
+
+- Charrier, L., Dehecq, A., Guo, L., Brun, F., Millan, R., Lioret, N., ... & Halas, P. (2025). TICOI: an operational
+  Python package to generate regular glacier velocity time series. EGUsphere, 2025, 1-40.
+
+- Charrier, L., Yan, Y., Koeniguer, E. C., Leinss, S., & Trouvé, E. (2021). Extraction of velocity time series with an
+  optimal temporal sampling from displacement observation networks. IEEE Transactions on Geoscience and Remote Sensing,
+  60, 1-10.
+
+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) 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.
+
+<p align="center">
+  <img src="examples/image/Temporal_closure.png" alt="Temporal_closure" width="800"/>
+</p>
+
+## INSTALLATION
+
+### With `mamba`
+
+Clone the git repo and create a `mamba` environment (see how to install `mamba` in
+the [mamba documentation](https://mamba.readthedocs.io/en/latest/)):
+
+```bash
+git clone git@github.com:ticoi/ticoi.git
+cd ticoi
+mamba env create -f environment.yml  # Add '-n custom_name' if you want.
+mamba activate environment  # Or any other name specified above
+```
+
+### With `pip`
+
+```bash
+python3.10 -m venv ticoi-env
+source ticoi-env/bin/activate
+pip install git+https://github.com/ticoi/ticoi.git
+```
+
+## TUTORIALS
+
+### Basic examples
+
+**- notebook**
+
+* [How to process one pixel of a NetCDF file](examples/basic/notebook/pixel_demo_local_ncdata.ipynb)
+* [How to process one pixel of ITS_LIVE data, stored on a cloud](examples/basic/notebook/pixel_demo_its_live_on_cloud.ipynb)
+
+**- python_script**
+
+* [How to process one cube](examples/basic/python_script/cube_ticoi_demo.py)
+* [How to process one pixel](examples/basic/python_script/pixel_ticoi_demo.py)
+
+### Advanced examples
+
+* [How to process one ITS_LIVE cube directly from the cloud](/examples/advanced/cube_ticoi_demo_its_live.py)
+* [How to format several geotiff files into a netCDF file](examples/advanced/cube_prep_from_geotiff.py)
+* [How to apply GLAFT on TICOI results](examples/advanced/glaft_for_ticoi_results.py)
+
+## TO USE YOUR OWN DATASET
+
+### You have geotiff files
+
+You need to convert them into netcdf, by
+modifying [this script](examples/advanced/cube_prep_from_geotiff.py).
+
+### You have netcdf files
+
+If it is [ITS_LIVE data]((https://its-live.jpl.nasa.gov/)), or [Millan et al., 2022](https://www.theia-land.fr/en/blog/product/glacier-surface-flow-velocity/), you can directly use them!
+If not, you have to create your own dataloader, within which the dimension should be ("mid_date", "y", "x"), and the
+variables should be "vx", "vy", and should contain the projection information in the ds.proj4 attribute. You can add in this [file](src/ticoi/cube_data_classxr.py).
+
+## HYPERPARAMETERS AND OUTPUTS
+
+* to understand the output of pixel_demo please
+  check [README_output](README_output.md)
+* to understand the parameters you can change, please
+  check [README_possible_parameters](README_possible_parameters.md)
+
+## TO CONTRIBUTE
+
+We welcome any contribution to this package! See guidelines [here](CONTRIBUTING.md).
+
+[packaging guide]: https://packaging.python.org
+
+[distribution tutorial]: https://packaging.python.org/tutorials/packaging-projects/
+
+[src]: https://github.com/pypa/sampleproject
+
+[rst]: http://docutils.sourceforge.net/rst.html
+
+[md]: https://tools.ietf.org/html/rfc7764#section-3.5 "CommonMark variant"
+
+[md use]: https://packaging.python.org/specifications/core-metadata/#description-content-type-optional

ticoi-0.0.1.dist-info/RECORD

@@ -0,0 +1,18 @@
+ticoi/__about__.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
+ticoi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ticoi/core.py,sha256=uW-t8g46sKEuJ2e_Xh--MXHRNwbyruOm84a3N6qRAT0,67652
+ticoi/cube_data_classxr.py,sha256=HSSVZmnfR3eDe_TnagmBHEPO1uAgqq_Jfgmy-sdZPik,103777
+ticoi/cube_writer.py,sha256=mGz79Drme9Ub983t_pS1-VIRHpSxRwU21GAoznkqYq4,32806
+ticoi/example.py,sha256=YqUPXH7YcW75O1w3VFkcgyOFChnn1OR0syxVop-lWM8,3300
+ticoi/filtering_functions.py,sha256=IYEZTllbrfmZ_EqtXFYyWaNFGaZ7akjmJ7HkYdcKIjU,26633
+ticoi/interpolation_functions.py,sha256=XXSDSMMHvgsu4CC5Nkwiy_n2VZxtXzYjcsut-Z5q6wg,9975
+ticoi/inversion_functions.py,sha256=OmYeIFYsLcWV7y4w_75KEPW7dd8OiMyAqzcRskgU-O8,54910
+ticoi/mjd2date.py,sha256=JvTybLkn0fgSIwjF5oMWh3ikiw7Acflq1-9yeqGcP_g,904
+ticoi/optimize_coefficient_functions.py,sha256=IRoumcK_KAspz4qeYEEaYDLsO_nvY3lke3L5pOzIxeU,8397
+ticoi/pixel_class.py,sha256=xv29Z3w7xTgdRQN7Qe6zeARwT-KdRMW8thIoJCj5Sw8,81771
+ticoi/seasonality_functions.py,sha256=4oMsHxgD1jlkJSsIDGFHmb311b48IkrT2xUx3Z4X-1g,9153
+ticoi/utils.py,sha256=tfmP2g5iF1MEq_Z1CBNCSz0KsMPRHI_lUgGEz_nGi3o,29403
+ticoi-0.0.1.dist-info/METADATA,sha256=fLQzemVjfHH9dJ9eYCt5wNrm9JIIdw055fejxdS84eM,6441
+ticoi-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ticoi-0.0.1.dist-info/licenses/LICENSE,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
+ticoi-0.0.1.dist-info/RECORD,,

ticoi-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ticoi-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER 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.
+
+
+  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.