ticoi 0.0.1__tar.gz → 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of ticoi might be problematic. Click here for more details.

Files changed (64) hide show
  1. {ticoi-0.0.1 → ticoi-0.1.0}/.github/workflows/pypi-publish.yml +3 -2
  2. ticoi-0.0.1/.github/workflows/test_hatch.yml → ticoi-0.1.0/.github/workflows/python-app.yml +5 -6
  3. {ticoi-0.0.1 → ticoi-0.1.0}/PKG-INFO +5 -8
  4. {ticoi-0.0.1 → ticoi-0.1.0}/README.md +3 -6
  5. ticoi-0.1.0/examples/advanced/stats_in_static_areas.py +13 -0
  6. ticoi-0.1.0/examples/basic/notebook/pixel_demo_its_live_on_cloud.ipynb +283 -0
  7. ticoi-0.1.0/examples/basic/notebook/pixel_demo_local_ncdata.ipynb +270 -0
  8. {ticoi-0.0.1 → ticoi-0.1.0}/pyproject.toml +3 -2
  9. ticoi-0.1.0/src/ticoi/__about__.py +1 -0
  10. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/cube_data_classxr.py +73 -110
  11. ticoi-0.1.0/tests/test_example.py +33 -0
  12. {ticoi-0.0.1 → ticoi-0.1.0}/tests/test_inversion_functions.py +8 -4
  13. ticoi-0.0.1/.github/workflows/python-app.yml +0 -49
  14. ticoi-0.0.1/examples/basic/notebook/pixel_demo_its_live_on_cloud.ipynb +0 -227
  15. ticoi-0.0.1/examples/basic/notebook/pixel_demo_local_ncdata.ipynb +0 -232
  16. ticoi-0.0.1/examples/basic/notebook/results/ILF_result.csv +0 -653
  17. ticoi-0.0.1/examples/basic/notebook/results/RLF_result.csv +0 -653
  18. ticoi-0.0.1/examples/basic/notebook/results/confidence_intervals_and_quality.png +0 -0
  19. ticoi-0.0.1/examples/basic/notebook/results/vv_interp.png +0 -0
  20. ticoi-0.0.1/examples/basic/notebook/results/vv_invert.png +0 -0
  21. ticoi-0.0.1/examples/basic/notebook/results/vv_obs.png +0 -0
  22. ticoi-0.0.1/src/ticoi/__about__.py +0 -1
  23. ticoi-0.0.1/test_data/Argentiere/Alpes_RGI7.dbf +0 -0
  24. ticoi-0.0.1/test_data/Argentiere/Alpes_RGI7.prj +0 -1
  25. ticoi-0.0.1/test_data/Argentiere/Alpes_RGI7.shp +0 -0
  26. ticoi-0.0.1/test_data/Argentiere/Alpes_RGI7.shx +0 -0
  27. ticoi-0.0.1/test_data/Argentiere/Argentiere_example_interp.nc +0 -0
  28. ticoi-0.0.1/test_data/Argentiere/Argentiere_iceflow.gpkg +0 -0
  29. ticoi-0.0.1/test_data/Argentiere/Argentiere_static.gpkg +0 -0
  30. ticoi-0.0.1/test_data/Lowell/ITS_LIVE_Lowell_Lower_test.nc +0 -0
  31. ticoi-0.0.1/tests/test_example.py +0 -16
  32. {ticoi-0.0.1 → ticoi-0.1.0}/.github/script/generate_yml_from_requirement.py +0 -0
  33. {ticoi-0.0.1 → ticoi-0.1.0}/.github/workflows/pre-commit.yml +0 -0
  34. {ticoi-0.0.1 → ticoi-0.1.0}/.gitignore +0 -0
  35. {ticoi-0.0.1 → ticoi-0.1.0}/.pre-commit-config.yaml +0 -0
  36. {ticoi-0.0.1 → ticoi-0.1.0}/.relint.yml +0 -0
  37. {ticoi-0.0.1 → ticoi-0.1.0}/CITATION.cff +0 -0
  38. {ticoi-0.0.1 → ticoi-0.1.0}/CODE_OF_CONDUCT.md +0 -0
  39. {ticoi-0.0.1 → ticoi-0.1.0}/CONTRIBUTING.md +0 -0
  40. {ticoi-0.0.1 → ticoi-0.1.0}/LICENSE +0 -0
  41. {ticoi-0.0.1 → ticoi-0.1.0}/README_output.md +0 -0
  42. {ticoi-0.0.1 → ticoi-0.1.0}/README_possible_parameters.md +0 -0
  43. {ticoi-0.0.1 → ticoi-0.1.0}/environment.yml +0 -0
  44. {ticoi-0.0.1 → ticoi-0.1.0}/examples/advanced/cube_prep_from_geotiff.py +0 -0
  45. {ticoi-0.0.1 → ticoi-0.1.0}/examples/advanced/cube_ticoi_demo_its_live.py +0 -0
  46. {ticoi-0.0.1 → ticoi-0.1.0}/examples/advanced/glaft_for_ticoi_results.py +0 -0
  47. {ticoi-0.0.1 → ticoi-0.1.0}/examples/basic/python_script/cube_ticoi_demo.py +0 -0
  48. {ticoi-0.0.1 → ticoi-0.1.0}/examples/basic/python_script/pixel_ticoi_demo.py +0 -0
  49. {ticoi-0.0.1 → ticoi-0.1.0}/examples/image/Temporal_closure.png +0 -0
  50. {ticoi-0.0.1 → ticoi-0.1.0}/src/__init__.py +0 -0
  51. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/__init__.py +0 -0
  52. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/core.py +0 -0
  53. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/cube_writer.py +0 -0
  54. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/example.py +0 -0
  55. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/filtering_functions.py +0 -0
  56. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/interpolation_functions.py +0 -0
  57. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/inversion_functions.py +0 -0
  58. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/mjd2date.py +0 -0
  59. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/optimize_coefficient_functions.py +0 -0
  60. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/pixel_class.py +0 -0
  61. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/seasonality_functions.py +0 -0
  62. {ticoi-0.0.1 → ticoi-0.1.0}/src/ticoi/utils.py +0 -0
  63. {ticoi-0.0.1 → ticoi-0.1.0}/tests/test_cube_data_class.py +0 -0
  64. {ticoi-0.0.1 → ticoi-0.1.0}/tests/test_filtering_functions.py +0 -0
@@ -1,6 +1,6 @@
1
1
  # This workflow will upload a Python Package using hatch when a release is created
2
2
  # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3
-
3
+ #Inspired from https://blog.pecar.me/automate-hatch-publish and https://github.com/shippp/hipp/blob/main/.github/workflows/pypi-publish.yml
4
4
  # This workflow uses actions that are not certified by GitHub.
5
5
  # They are provided by a third-party and are governed by
6
6
  # separate terms of service, privacy policy, and support
@@ -27,9 +27,10 @@ jobs:
27
27
  uses: actions/setup-python@v5
28
28
  with:
29
29
  python-version: "3.10"
30
+ cache: 'pip'
30
31
 
31
32
  - name: Install Hatch
32
- run: pipx install hatch
33
+ run: pip install hatch
33
34
 
34
35
  # - name: Run tests
35
36
  # uses: hatch run dev:pytest
@@ -1,12 +1,12 @@
1
- name: test
1
+ name: Python test
2
2
 
3
3
  on:
4
4
  push:
5
5
  branches:
6
- - master
6
+ - main
7
7
  pull_request:
8
8
  branches:
9
- - master
9
+ - main
10
10
 
11
11
  concurrency:
12
12
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
@@ -40,10 +40,9 @@ jobs:
40
40
  - name: Install ourself
41
41
  run: |
42
42
  uv pip install --system -e .
43
- uv pip install --system -e ./backend
44
43
 
45
- - name: Run static analysis
46
- run: hatch fmt --check
44
+ - name: Install hatch
45
+ run: uv pip install --system hatch
47
46
 
48
47
  - name: Run tests
49
48
  run: hatch test --python ${{ matrix.python-version }} --cover-quiet --randomize --parallel --retries 5 --retry-delay 3
@@ -1,9 +1,9 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ticoi
3
- Version: 0.0.1
3
+ Version: 0.1.0
4
4
  Summary: A package to run Temporal Inversion using linear Combinations of Observations, and Interpolation (TICOI)
5
5
  Project-URL: Homepage, https://github.com/ticoi/ticoi.git
6
- Project-URL: Issues, https://github.com/pypa/sampleproject/issues
6
+ Project-URL: Issues, https://github.com/ticoi/ticoi/issues
7
7
  Author: Lei Guo
8
8
  Author-email: Laurane Charrier <laurane.charrier@outlook.com>
9
9
  License: GPL-3.0-only
@@ -81,18 +81,14 @@ Clone the git repo and create a `mamba` environment (see how to install `mamba`
81
81
  the [mamba documentation](https://mamba.readthedocs.io/en/latest/)):
82
82
 
83
83
  ```bash
84
- git clone git@github.com:ticoi/ticoi.git
85
- cd ticoi
86
84
  mamba env create -f environment.yml # Add '-n custom_name' if you want.
87
- mamba activate environment # Or any other name specified above
85
+ mamba install -c conda-forge ticoi
88
86
  ```
89
87
 
90
88
  ### With `pip`
91
89
 
92
90
  ```bash
93
- python3.10 -m venv ticoi-env
94
- source ticoi-env/bin/activate
95
- pip install git+https://github.com/ticoi/ticoi.git
91
+ pip install ticoi
96
92
  ```
97
93
 
98
94
  ## TUTORIALS
@@ -114,6 +110,7 @@ pip install git+https://github.com/ticoi/ticoi.git
114
110
  * [How to process one ITS_LIVE cube directly from the cloud](/examples/advanced/cube_ticoi_demo_its_live.py)
115
111
  * [How to format several geotiff files into a netCDF file](examples/advanced/cube_prep_from_geotiff.py)
116
112
  * [How to apply GLAFT on TICOI results](examples/advanced/glaft_for_ticoi_results.py)
113
+ * [How to compute statistics in static areas](examples/advanced/stats_in_static_areas.py)
117
114
 
118
115
  ## TO USE YOUR OWN DATASET
119
116
 
@@ -43,18 +43,14 @@ Clone the git repo and create a `mamba` environment (see how to install `mamba`
43
43
  the [mamba documentation](https://mamba.readthedocs.io/en/latest/)):
44
44
 
45
45
  ```bash
46
- git clone git@github.com:ticoi/ticoi.git
47
- cd ticoi
48
46
  mamba env create -f environment.yml # Add '-n custom_name' if you want.
49
- mamba activate environment # Or any other name specified above
47
+ mamba install -c conda-forge ticoi
50
48
  ```
51
49
 
52
50
  ### With `pip`
53
51
 
54
52
  ```bash
55
- python3.10 -m venv ticoi-env
56
- source ticoi-env/bin/activate
57
- pip install git+https://github.com/ticoi/ticoi.git
53
+ pip install ticoi
58
54
  ```
59
55
 
60
56
  ## TUTORIALS
@@ -76,6 +72,7 @@ pip install git+https://github.com/ticoi/ticoi.git
76
72
  * [How to process one ITS_LIVE cube directly from the cloud](/examples/advanced/cube_ticoi_demo_its_live.py)
77
73
  * [How to format several geotiff files into a netCDF file](examples/advanced/cube_prep_from_geotiff.py)
78
74
  * [How to apply GLAFT on TICOI results](examples/advanced/glaft_for_ticoi_results.py)
75
+ * [How to compute statistics in static areas](examples/advanced/stats_in_static_areas.py)
79
76
 
80
77
  ## TO USE YOUR OWN DATASET
81
78
 
@@ -0,0 +1,13 @@
1
+ from ticoi.cube_data_classxr import CubeDataClass
2
+ from ticoi.example import get_path
3
+
4
+
5
+ cube_name = get_path("Argentiere_example_interp") # path to our dataset
6
+ stable_area = get_path("Argentiere_static")
7
+
8
+ cube = CubeDataClass()
9
+ cube.load(cube_name, pick_date=["2017-01-01", "2017-03-30"])
10
+ # Compute normalized median absolute deviation
11
+ nmad = cube.compute_nmad(shapefile_path=stable_area, return_as="dataframe")
12
+ # Compte median over stable areas
13
+ med = cube.compute_med_static_areas(shapefile_path=stable_area, return_as="dataframe")