ivert 0.6.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.
Files changed (107) hide show
  1. ivert-0.6.0/.github/dependabot.yml +12 -0
  2. ivert-0.6.0/.github/workflows/codacy.yml +61 -0
  3. ivert-0.6.0/.github/workflows/publish-to-pypi.yml +69 -0
  4. ivert-0.6.0/.github/workflows/zizmor.yml +29 -0
  5. ivert-0.6.0/.gitignore +169 -0
  6. ivert-0.6.0/.pre-commit-config.yaml +27 -0
  7. ivert-0.6.0/LICENSE +21 -0
  8. ivert-0.6.0/PKG-INFO +133 -0
  9. ivert-0.6.0/README.md +75 -0
  10. ivert-0.6.0/archive/README.md +7 -0
  11. ivert-0.6.0/archive/config/email_templates.ini +80 -0
  12. ivert-0.6.0/archive/config/ivert_config_v0.5.3.ini +208 -0
  13. ivert-0.6.0/archive/config/ivert_job_config_TEMPLATE.ini +39 -0
  14. ivert-0.6.0/archive/config/ivert_jobs_schema.sql +151 -0
  15. ivert-0.6.0/archive/config/ivert_personal_creds_TEMPLATE.txt +5 -0
  16. ivert-0.6.0/archive/config/ivert_s3_credentials_TEMPLATE.ini +29 -0
  17. ivert-0.6.0/archive/config/ivert_user_config_TEMPLATE.ini +16 -0
  18. ivert-0.6.0/archive/src/VERSION_CLIENT_MIN +4 -0
  19. ivert-0.6.0/archive/src/analyze_validation_results.py +60 -0
  20. ivert-0.6.0/archive/src/atl_dataset.py +273 -0
  21. ivert-0.6.0/archive/src/atl_granules.py +471 -0
  22. ivert-0.6.0/archive/src/atl_variable_finder.py +3647 -0
  23. ivert-0.6.0/archive/src/classify_icesat2_photons.py +667 -0
  24. ivert-0.6.0/archive/src/clean_ivert_files.py +354 -0
  25. ivert-0.6.0/archive/src/client.py +469 -0
  26. ivert-0.6.0/archive/src/client_job_download.py +164 -0
  27. ivert-0.6.0/archive/src/client_job_import.py +158 -0
  28. ivert-0.6.0/archive/src/client_job_status.py +208 -0
  29. ivert-0.6.0/archive/src/client_job_test.py +84 -0
  30. ivert-0.6.0/archive/src/client_job_update.py +40 -0
  31. ivert-0.6.0/archive/src/client_job_upload.py +273 -0
  32. ivert-0.6.0/archive/src/client_job_validate.py +125 -0
  33. ivert-0.6.0/archive/src/client_subscriptions.py +53 -0
  34. ivert-0.6.0/archive/src/client_user_setup.py +978 -0
  35. ivert-0.6.0/archive/src/coastline_mask_OLD.py +319 -0
  36. ivert-0.6.0/archive/src/coastline_mask_v2.py +195 -0
  37. ivert-0.6.0/archive/src/convert_vdatum.py +316 -0
  38. ivert-0.6.0/archive/src/download_all_icesat2_granules.py +1069 -0
  39. ivert-0.6.0/archive/src/find_bad_icesat2_granules.py +967 -0
  40. ivert-0.6.0/archive/src/icesat2_photon_database_OLD.py +1413 -0
  41. ivert-0.6.0/archive/src/icesat2_query.py +1136 -0
  42. ivert-0.6.0/archive/src/icesat2_tile_database.py +401 -0
  43. ivert-0.6.0/archive/src/jobs_database.py +1591 -0
  44. ivert-0.6.0/archive/src/nsidc_download.py +859 -0
  45. ivert-0.6.0/archive/src/plot_photon_clouds.py +281 -0
  46. ivert-0.6.0/archive/src/quarantine_manager.py +48 -0
  47. ivert-0.6.0/archive/src/s3.py +1236 -0
  48. ivert-0.6.0/archive/src/server_file_export.py +100 -0
  49. ivert-0.6.0/archive/src/server_job_manager.py +1668 -0
  50. ivert-0.6.0/archive/src/server_job_validate.py +130 -0
  51. ivert-0.6.0/archive/src/server_maintain_manager.py +82 -0
  52. ivert-0.6.0/archive/src/server_proc.sh +56 -0
  53. ivert-0.6.0/archive/src/server_rest_api.py +44 -0
  54. ivert-0.6.0/archive/src/sns.py +133 -0
  55. ivert-0.6.0/archive/src/validation_pool_manager_UNUSED.py +319 -0
  56. ivert-0.6.0/archive/src/version_check_client.py +59 -0
  57. ivert-0.6.0/archive/src/version_check_server.py +38 -0
  58. ivert-0.6.0/docs/cache.md +48 -0
  59. ivert-0.6.0/docs/database.md +180 -0
  60. ivert-0.6.0/docs/images/.gitkeep +0 -0
  61. ivert-0.6.0/docs/images/ICESat2_Boston_Map.png +0 -0
  62. ivert-0.6.0/docs/images/ICESat2_orbit_example.png +0 -0
  63. ivert-0.6.0/docs/images/IVERT_outputs_example.png +0 -0
  64. ivert-0.6.0/docs/options.md +132 -0
  65. ivert-0.6.0/docs/upgrade.md +11 -0
  66. ivert-0.6.0/docs/validate.md +144 -0
  67. ivert-0.6.0/pyproject.toml +60 -0
  68. ivert-0.6.0/src/ivert/__init__.py +18 -0
  69. ivert-0.6.0/src/ivert/_version.py +4 -0
  70. ivert-0.6.0/src/ivert/cli.py +999 -0
  71. ivert-0.6.0/src/ivert/client_upgrade.py +22 -0
  72. ivert-0.6.0/src/ivert/coastline_mask.py +218 -0
  73. ivert-0.6.0/src/ivert/config/ivert_defaults.ini +102 -0
  74. ivert-0.6.0/src/ivert/convert_error_tif_to_vector.py +57 -0
  75. ivert-0.6.0/src/ivert/export_vector.py +268 -0
  76. ivert-0.6.0/src/ivert/icesat2_database_v2.py +1330 -0
  77. ivert-0.6.0/src/ivert/icesat2_requests.py +220 -0
  78. ivert-0.6.0/src/ivert/ivert_jobs.py +62 -0
  79. ivert-0.6.0/src/ivert/plot_photon_clouds_v2.py +605 -0
  80. ivert-0.6.0/src/ivert/plot_results_slope_centrality.py +241 -0
  81. ivert-0.6.0/src/ivert/plot_validation_results.py +720 -0
  82. ivert-0.6.0/src/ivert/transform_points.py +169 -0
  83. ivert-0.6.0/src/ivert/utils/__init__.py +0 -0
  84. ivert-0.6.0/src/ivert/utils/bcolors.py +25 -0
  85. ivert-0.6.0/src/ivert/utils/configfile.py +403 -0
  86. ivert-0.6.0/src/ivert/utils/create_empty_tiff.py +28 -0
  87. ivert-0.6.0/src/ivert/utils/cuboid_funcs.py +565 -0
  88. ivert-0.6.0/src/ivert/utils/dem_geom.py +190 -0
  89. ivert-0.6.0/src/ivert/utils/fetch_text.py +108 -0
  90. ivert-0.6.0/src/ivert/utils/is_aws.py +23 -0
  91. ivert-0.6.0/src/ivert/utils/is_conda.py +15 -0
  92. ivert-0.6.0/src/ivert/utils/is_email.py +37 -0
  93. ivert-0.6.0/src/ivert/utils/list_photon_tiles.py +49 -0
  94. ivert-0.6.0/src/ivert/utils/loggerproc.py +141 -0
  95. ivert-0.6.0/src/ivert/utils/parallel_funcs.py +277 -0
  96. ivert-0.6.0/src/ivert/utils/pickle_blosc.py +19 -0
  97. ivert-0.6.0/src/ivert/utils/progress_bar.py +116 -0
  98. ivert-0.6.0/src/ivert/utils/pyproj_funcs.py +188 -0
  99. ivert-0.6.0/src/ivert/utils/query_yes_no.py +50 -0
  100. ivert-0.6.0/src/ivert/utils/sizeof_format.py +20 -0
  101. ivert-0.6.0/src/ivert/utils/split_dem.py +131 -0
  102. ivert-0.6.0/src/ivert/utils/traverse_directory.py +78 -0
  103. ivert-0.6.0/src/ivert/utils/unformat_text.py +39 -0
  104. ivert-0.6.0/src/ivert/utils/version.py +7 -0
  105. ivert-0.6.0/src/ivert/validate_dem.py +1864 -0
  106. ivert-0.6.0/src/ivert/validate_dem_collection.py +534 -0
  107. ivert-0.6.0/src/ivert/vdatum_lookup.py +235 -0
@@ -0,0 +1,12 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: "github-actions"
4
+ directory: "/"
5
+ schedule:
6
+ interval: "monthly"
7
+ cooldown:
8
+ default-days: 7
9
+ groups:
10
+ gha-dependencies:
11
+ patterns:
12
+ - "*"
@@ -0,0 +1,61 @@
1
+ # This workflow uses actions that are not certified by GitHub.
2
+ # They are provided by a third-party and are governed by
3
+ # separate terms of service, privacy policy, and support
4
+ # documentation.
5
+
6
+ # This workflow checks out code, performs a Codacy security scan
7
+ # and integrates the results with the
8
+ # GitHub Advanced Security code scanning feature. For more information on
9
+ # the Codacy security scan action usage and parameters, see
10
+ # https://github.com/codacy/codacy-analysis-cli-action.
11
+ # For more information on Codacy Analysis CLI in general, see
12
+ # https://github.com/codacy/codacy-analysis-cli.
13
+
14
+ name: Codacy Security Scan
15
+
16
+ on:
17
+ push:
18
+ branches: [ "main" ]
19
+ pull_request:
20
+ # The branches below must be a subset of the branches above
21
+ branches: [ "main" ]
22
+ schedule:
23
+ - cron: '17 11 * * 6'
24
+
25
+ permissions:
26
+ contents: read
27
+
28
+ jobs:
29
+ codacy-security-scan:
30
+ permissions:
31
+ contents: read # for actions/checkout to fetch code
32
+ security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
33
+ actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
34
+ name: Codacy Security Scan
35
+ runs-on: ubuntu-latest
36
+ steps:
37
+ # Checkout the repository to the GitHub Actions runner
38
+ - name: Checkout code
39
+ uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
40
+
41
+ # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
42
+ - name: Run Codacy Analysis CLI
43
+ uses: codacy/codacy-analysis-cli-action@d840f886c4bd4edc059706d09c6a1586111c540b
44
+ with:
45
+ # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
46
+ # You can also omit the token and run the tools that support default configurations
47
+ project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
48
+ verbose: true
49
+ output: results.sarif
50
+ format: sarif
51
+ # Adjust severity of non-security issues
52
+ gh-code-scanning-compat: true
53
+ # Force 0 exit code to allow SARIF file generation
54
+ # This will handover control about PR rejection to the GitHub side
55
+ max-allowed-issues: 2147483647
56
+
57
+ # Upload the SARIF file generated in the previous step
58
+ - name: Upload SARIF results file
59
+ uses: github/codeql-action/upload-sarif@02c5e83432fe5497fd85b873b6c9f16a8578e1d9 # v3
60
+ with:
61
+ sarif_file: results.sarif
@@ -0,0 +1,69 @@
1
+ name: "Build & publish to PyPI"
2
+
3
+ on:
4
+ pull_request:
5
+ release:
6
+ types:
7
+ # Triggers when you click "Publish release" in GitHub
8
+ - "published"
9
+
10
+ permissions: {}
11
+
12
+ jobs:
13
+ build:
14
+ name: "Build"
15
+ runs-on: "ubuntu-latest"
16
+ steps:
17
+ - name: "Checkout code"
18
+ uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
19
+ with:
20
+ persist-credentials: false
21
+
22
+ - name: "Set up Python"
23
+ uses: "actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405" # v6.2.0
24
+ with:
25
+ python-version: "3.x"
26
+
27
+ - name: "Install build tools"
28
+ run: |
29
+ python -m pip install --upgrade pip
30
+ pip install build
31
+
32
+ - name: "Build package"
33
+ run: "python -m build"
34
+
35
+ - uses: "prefix-dev/setup-pixi@ba3bb36eb2066252b2363392b7739741bb777659" # v0.8.1
36
+ with:
37
+ run-install: false
38
+
39
+ - name: "Test built package"
40
+ shell: "pixi exec --list --spec libgdal-core -- bash -e {0}"
41
+ run: |
42
+ python -m pip install dist/*.whl
43
+ cd /tmp
44
+ python -c "import ivert; print(f'Version: {ivert.__version__}')"
45
+ ivert --version
46
+
47
+ - uses: "actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f" # v7.0.0
48
+ with:
49
+ name: "dist"
50
+ path: "dist/"
51
+
52
+ pypi-publish:
53
+ name: "Publish to PyPI"
54
+ runs-on: "ubuntu-latest"
55
+ if: "github.event_name == 'release'"
56
+ needs: "build"
57
+ environment:
58
+ name: "pypi"
59
+ url: "https://pypi.org/p/ivert"
60
+ permissions:
61
+ id-token: "write"
62
+ steps:
63
+ - name: "Get dist artifact"
64
+ uses: "actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c" # v8.0.1
65
+ with:
66
+ name: "dist"
67
+ path: "dist/"
68
+ - name: "Publish to PyPI"
69
+ uses: "pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b" # release/v1
@@ -0,0 +1,29 @@
1
+ name: "GitHub Actions Security Analysis with zizmor 🌈"
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - "main"
7
+ paths:
8
+ - ".github/workflows/*"
9
+ pull_request:
10
+ paths:
11
+ - ".github/workflows/*"
12
+
13
+
14
+ permissions: {}
15
+
16
+ jobs:
17
+ zizmor:
18
+ name: "Run zizmor 🌈"
19
+ runs-on: "ubuntu-latest"
20
+ permissions:
21
+ security-events: "write" # Required for upload-sarif (used by zizmor-action) to upload SARIF files.
22
+ steps:
23
+ - name: "Checkout repository"
24
+ uses: "actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0" # v7.0.0
25
+ with:
26
+ persist-credentials: false
27
+
28
+ - name: "Run zizmor 🌈"
29
+ uses: "zizmorcore/zizmor-action@192e21d79ab29983730a13d1382995c2307fbcaa" # v0.5.7
ivert-0.6.0/.gitignore ADDED
@@ -0,0 +1,169 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+ _version.py
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+ cover/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ #Pipfile.lock
97
+
98
+ # poetry
99
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
103
+ #poetry.lock
104
+
105
+ # pdm
106
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
107
+ #pdm.lock
108
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
109
+ # in version control.
110
+ # https://pdm.fming.dev/#use-with-ide
111
+ .pdm.toml
112
+
113
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
114
+ __pypackages__/
115
+
116
+ # Celery stuff
117
+ celerybeat-schedule
118
+ celerybeat.pid
119
+
120
+ # SageMath parsed files
121
+ *.sage.py
122
+
123
+ # Environments
124
+ .env
125
+ .venv
126
+ env/
127
+ venv/
128
+ ENV/
129
+ env.bak/
130
+ venv.bak/
131
+
132
+ # Spyder project settings
133
+ .spyderproject
134
+ .spyproject
135
+
136
+ # Rope project settings
137
+ .ropeproject
138
+
139
+ # mkdocs documentation
140
+ /site
141
+
142
+ # mypy
143
+ .mypy_cache/
144
+ .dmypy.json
145
+ dmypy.json
146
+
147
+ # Pyre type checker
148
+ .pyre/
149
+
150
+ # pytype static type analyzer
151
+ .pytype/
152
+
153
+ # Cython debug symbols
154
+ cython_debug/
155
+
156
+ # PyCharm
157
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
158
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
159
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
160
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
161
+ .idea/
162
+ data/*
163
+ scratch_data/*
164
+ src/tests/
165
+ src/tests_old/
166
+
167
+ # Any project-specific Claude Code helper files.
168
+ CLAUDE.md
169
+ .claude/
@@ -0,0 +1,27 @@
1
+ ci:
2
+ autoupdate_schedule: quarterly
3
+ autofix_prs: false
4
+
5
+ repos:
6
+ - repo: https://github.com/pre-commit/pre-commit-hooks
7
+ rev: v6.0.0
8
+ hooks:
9
+ - id: forbid-new-submodules
10
+ - id: end-of-file-fixer
11
+ - id: check-case-conflict
12
+ - id: requirements-txt-fixer
13
+ - id: check-added-large-files
14
+ args: ['--maxkb=500']
15
+ - id: check-json
16
+ - id: check-toml
17
+ - id: check-yaml
18
+ - id: debug-statements
19
+ - id: check-builtin-literals
20
+ - id: trailing-whitespace
21
+
22
+ - repo: https://github.com/astral-sh/ruff-pre-commit
23
+ rev: v0.15.9
24
+ hooks:
25
+ - id: ruff-check
26
+ args: ['--fix']
27
+ - id: ruff-format
ivert-0.6.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 CIRES Coastal DEM Group
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
ivert-0.6.0/PKG-INFO ADDED
@@ -0,0 +1,133 @@
1
+ Metadata-Version: 2.4
2
+ Name: ivert
3
+ Version: 0.6.0
4
+ Summary: The ICESat-2 Validation of Elevations Reporting Tool (IVERT)
5
+ Project-URL: Source, https://github.com/ciresdem/IVERT
6
+ Author-email: Michael MacFerrin <michael.macferrin@colorado.edu>
7
+ License: MIT License
8
+
9
+ Copyright (c) 2023 CIRES Coastal DEM Group
10
+
11
+ Permission is hereby granted, free of charge, to any person obtaining a copy
12
+ of this software and associated documentation files (the "Software"), to deal
13
+ in the Software without restriction, including without limitation the rights
14
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
+ copies of the Software, and to permit persons to whom the Software is
16
+ furnished to do so, subject to the following conditions:
17
+
18
+ The above copyright notice and this permission notice shall be included in all
19
+ copies or substantial portions of the Software.
20
+
21
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
+ SOFTWARE.
28
+ License-File: LICENSE
29
+ Keywords: Geospatial
30
+ Classifier: License :: OSI Approved :: MIT License
31
+ Classifier: Operating System :: OS Independent
32
+ Classifier: Programming Language :: Python :: 3
33
+ Requires-Python: >=3.12
34
+ Requires-Dist: blosc2
35
+ Requires-Dist: click
36
+ Requires-Dist: dateparser
37
+ Requires-Dist: fetchez
38
+ Requires-Dist: gdal
39
+ Requires-Dist: geopandas
40
+ Requires-Dist: globato
41
+ Requires-Dist: h5py
42
+ Requires-Dist: matplotlib
43
+ Requires-Dist: netcdf4
44
+ Requires-Dist: numexpr
45
+ Requires-Dist: numpy
46
+ Requires-Dist: packaging
47
+ Requires-Dist: pandas
48
+ Requires-Dist: psutil
49
+ Requires-Dist: pyproj
50
+ Requires-Dist: rasterio
51
+ Requires-Dist: scipy
52
+ Requires-Dist: shapely
53
+ Requires-Dist: six
54
+ Requires-Dist: tabulate
55
+ Requires-Dist: transformez
56
+ Requires-Dist: xarray
57
+ Description-Content-Type: text/markdown
58
+
59
+ # IVERT
60
+ **ICESat-2 Validation of Elevations Reporting Tool**
61
+
62
+ IVERT validates Digital Elevation Models (DEMs) by comparing their elevations against ICESat-2 satellite photon data. It supports topographic, bathymetric, and mixed coastal DEMs, runs fully offline on any machine, and handles vertical datum conversions automatically.
63
+
64
+ Developed by the [CIRES Coastal DEM Team](https://ciresdem.github.io). Primary authors: [Mike MacFerrin](https://github.com/mmacferrin) (IVERT) and [Matthew Love](https://github.com/matth-love) ([continuous-dems](https://github.com/continuous-dems) utilities).
65
+
66
+ > **Note:** This repository will soon be ported over to the [continuous-dems](https://github.com/continuous-dems) ecosystem.
67
+
68
+ ---
69
+
70
+ (TODO: Add some pretty pictures here)
71
+
72
+ ---
73
+
74
+ ## Capabilities
75
+
76
+ - Validate topographic, bathymetric, and coastal DEMs against ICESat-2 ATL03/ATL24 photons
77
+ - Combines [ATL03](https://nsidc.org/data/atl03/)/[ATL08](https://nsidc.org/data/atl08/)/[ATL13](https://nsidc.org/data/atl13/)/[ATL24](https://nsidc.org/data/atl24/) for photon-level classifications, plus external datasets (such as the [Global Buildings Atlas](https://tubvsig-so2sat-vm1.srv.mwn.de/)) to classify built structures.
78
+ - Additional coastline filtering to minimize false-positive ATL08 "ground" photons appearing offshore over water, and unreasonably-shallow "bathy floor" photons with large errors over deep water.
79
+ - Automatic vertical datum conversions (NAVD88, EGM2008, MLLW, and many more)
80
+ - Configurable photon confidence and quality filtering
81
+ - Statistical outputs: bias, RMSE, NMAD, per-cell error maps
82
+ - Automatically-generated plots of DEM accuracies compared to ICESat-2.
83
+ - Export errors to GeoTIFF, GeoPackage, Shapefile, or XYZ text
84
+ - Local photon database management — download once, validate many times
85
+
86
+ ---
87
+
88
+ ## Installation
89
+
90
+ ```bash
91
+ pip install ivert
92
+ ```
93
+ (^ coming soon)
94
+
95
+ For development (editable install from this repo):
96
+
97
+ ```bash
98
+ git clone https://github.com/ciresdem/IVERT.git
99
+ cd IVERT
100
+ pip install -e .
101
+ ```
102
+
103
+ Three dependencies — `fetchez`, `globato`, and `transformez` — are pulled automatically from the [continuous-dems](https://github.com/continuous-dems) GitHub organization and do not need to be installed separately.
104
+
105
+ ---
106
+
107
+ ## Quick start
108
+
109
+ **1. Download ICESat-2 photon data for your area** (bounding box in W/E/S/N order):
110
+
111
+ ```bash
112
+ ivert database download -- -74.0/-73.0/40.5/41.0
113
+ ```
114
+
115
+ **2. Validate your DEM:**
116
+
117
+ ```bash
118
+ ivert validate mydem.tif
119
+ ```
120
+
121
+ **3. Check the output directory** for `mydem_results.h5`, a validation plot (`.png`), and error exports (`.tif`, `.gpkg`).
122
+
123
+ ---
124
+
125
+ ## Documentation
126
+
127
+ | Command | Description |
128
+ |---------|-------------|
129
+ | [ivert validate](docs/validate.md) | Validate DEMs against ICESat-2 data |
130
+ | [ivert database](docs/database.md) | Download and manage the local photon database |
131
+ | [ivert cache](docs/cache.md) | View and clear the local file cache |
132
+ | [ivert options](docs/options.md) | View and change configuration settings |
133
+ | [ivert upgrade](docs/upgrade.md) | Upgrade IVERT to the latest version |
ivert-0.6.0/README.md ADDED
@@ -0,0 +1,75 @@
1
+ # IVERT
2
+ **ICESat-2 Validation of Elevations Reporting Tool**
3
+
4
+ IVERT validates Digital Elevation Models (DEMs) by comparing their elevations against ICESat-2 satellite photon data. It supports topographic, bathymetric, and mixed coastal DEMs, runs fully offline on any machine, and handles vertical datum conversions automatically.
5
+
6
+ Developed by the [CIRES Coastal DEM Team](https://ciresdem.github.io). Primary authors: [Mike MacFerrin](https://github.com/mmacferrin) (IVERT) and [Matthew Love](https://github.com/matth-love) ([continuous-dems](https://github.com/continuous-dems) utilities).
7
+
8
+ > **Note:** This repository will soon be ported over to the [continuous-dems](https://github.com/continuous-dems) ecosystem.
9
+
10
+ ---
11
+
12
+ (TODO: Add some pretty pictures here)
13
+
14
+ ---
15
+
16
+ ## Capabilities
17
+
18
+ - Validate topographic, bathymetric, and coastal DEMs against ICESat-2 ATL03/ATL24 photons
19
+ - Combines [ATL03](https://nsidc.org/data/atl03/)/[ATL08](https://nsidc.org/data/atl08/)/[ATL13](https://nsidc.org/data/atl13/)/[ATL24](https://nsidc.org/data/atl24/) for photon-level classifications, plus external datasets (such as the [Global Buildings Atlas](https://tubvsig-so2sat-vm1.srv.mwn.de/)) to classify built structures.
20
+ - Additional coastline filtering to minimize false-positive ATL08 "ground" photons appearing offshore over water, and unreasonably-shallow "bathy floor" photons with large errors over deep water.
21
+ - Automatic vertical datum conversions (NAVD88, EGM2008, MLLW, and many more)
22
+ - Configurable photon confidence and quality filtering
23
+ - Statistical outputs: bias, RMSE, NMAD, per-cell error maps
24
+ - Automatically-generated plots of DEM accuracies compared to ICESat-2.
25
+ - Export errors to GeoTIFF, GeoPackage, Shapefile, or XYZ text
26
+ - Local photon database management — download once, validate many times
27
+
28
+ ---
29
+
30
+ ## Installation
31
+
32
+ ```bash
33
+ pip install ivert
34
+ ```
35
+ (^ coming soon)
36
+
37
+ For development (editable install from this repo):
38
+
39
+ ```bash
40
+ git clone https://github.com/ciresdem/IVERT.git
41
+ cd IVERT
42
+ pip install -e .
43
+ ```
44
+
45
+ Three dependencies — `fetchez`, `globato`, and `transformez` — are pulled automatically from the [continuous-dems](https://github.com/continuous-dems) GitHub organization and do not need to be installed separately.
46
+
47
+ ---
48
+
49
+ ## Quick start
50
+
51
+ **1. Download ICESat-2 photon data for your area** (bounding box in W/E/S/N order):
52
+
53
+ ```bash
54
+ ivert database download -- -74.0/-73.0/40.5/41.0
55
+ ```
56
+
57
+ **2. Validate your DEM:**
58
+
59
+ ```bash
60
+ ivert validate mydem.tif
61
+ ```
62
+
63
+ **3. Check the output directory** for `mydem_results.h5`, a validation plot (`.png`), and error exports (`.tif`, `.gpkg`).
64
+
65
+ ---
66
+
67
+ ## Documentation
68
+
69
+ | Command | Description |
70
+ |---------|-------------|
71
+ | [ivert validate](docs/validate.md) | Validate DEMs against ICESat-2 data |
72
+ | [ivert database](docs/database.md) | Download and manage the local photon database |
73
+ | [ivert cache](docs/cache.md) | View and clear the local file cache |
74
+ | [ivert options](docs/options.md) | View and change configuration settings |
75
+ | [ivert upgrade](docs/upgrade.md) | Upgrade IVERT to the latest version |
@@ -0,0 +1,7 @@
1
+ # Archive
2
+
3
+ These files are deprecated from previous versions of IVERT and are not currently in use.
4
+ They are retained for reference in case cloud/server features are re-integrated in the future.
5
+
6
+ - `src/` — archived Python source modules
7
+ - `config/` — archived configuration files and templates
@@ -0,0 +1,80 @@
1
+ [DEFAULT]
2
+ # email_templates.ini -- Email templates for IVERT, using the SNS notification system (see sns.py)
3
+
4
+ # Subject line for when a job is submitted and detected on the EC2.
5
+ # 0: username,
6
+ # 1: job_id
7
+ subject_job_submitted = "IVERT: Job {0}_{1} has been created"
8
+
9
+ # Generic email intro from IVERT.
10
+ email_ending = """This is an automated message from the ICESat-2 Validation of Elevations Reporting Tool (IVERT). Do not reply to this message.
11
+ """
12
+
13
+ # Email template to send out when a job is submitted and detected on the EC2.
14
+ # 0: username,
15
+ # 1: job_id
16
+ # 2: full command being processed
17
+ email_job_submitted = """
18
+ Your IVERT job "{0}_{1}" has been created and queued for processing.
19
+
20
+ The following IVERT command is being run on the EC2 server:
21
+ {2}
22
+
23
+ You can monitor the status of your job at any time by running "ivert status {0}_{1}" at the command line.
24
+
25
+ You should get another email when the job is complete and results (if any) are ready to download.
26
+ """
27
+
28
+ # May re-include this line if/when we get a 'kill' option implemented to stop/kill an src job.
29
+ # If you wish to cancel this job, run "src kill {0}_{1}" at the command line and it will be terminated when the EC2 receives the notification. All files uploaded with the job will be deleted. Output files already exported will remain for 7 days before being deleted.
30
+
31
+ # Subject line for when a job is finished.
32
+ # 0: username,
33
+ # 1: job_id
34
+ # 2: "completed successfully", "completed with partial success", "terminated unexpectedly", or "been killed"
35
+ subject_job_finished = "IVERT: Job {0}_{1} has finished with status '{2}'"
36
+
37
+ # Email template to send out if the job is finished without any exports.
38
+ # 0: username,
39
+ # 1: job_id
40
+ # 2: The status from the ivert_jobs table of the finished job.
41
+ email_job_finished_start = """
42
+ Your IVERT job "{0}_{1}" has finished with status '{2}'.
43
+ """
44
+
45
+ # 0: number of input files processed (not including the Config file)
46
+ # 1: number of input files processed successfully.
47
+ # 2: number of input files processed unsuccessfully (errors, etc)
48
+ email_job_finished_input_files_addendum = """
49
+ {0} input files ({1} successful, {2} unsuccessful):
50
+ """
51
+
52
+ # 0: The file name
53
+ # 1: The file size
54
+ # 2: The file status
55
+ file_item = """ - {0}, {1}: '{2}'
56
+ """
57
+
58
+ # 0: number of total output files.
59
+ # 1: number of output files processed successfully.
60
+ # 2: number of output files processed unsuccessfully (errors, etc)
61
+ email_job_finished_output_files_addendum = """
62
+ {0} output files ({1} successful, {2} unsuccessful):
63
+ """
64
+
65
+ # Addendum of there are any files available to download.
66
+ # 0: username
67
+ # 1: job_id
68
+ email_output_files_download_notification = """
69
+ You can download the output files by running "ivert download {0}_{1}" at the command line. Files will be availabe online for 7 days before being deleted.
70
+ """
71
+
72
+ # An addendum to add if any files were not completed successfully, or if the job itself was unsuccessful or
73
+ # terminated abruptly.
74
+ # 0: username,
75
+ # 1: job_id
76
+ email_job_finished_unsuccessful_addendum = """
77
+ If the job was unsuccessful or any files were not completed successfully, you may download a
78
+ detailed logfile by running "ivert download {0}_{1}" at the command line.
79
+ You can forward this email to your IVERT developers to debug and fix the issue.
80
+ """