Metadata-Version: 2.1
Name: icepy4d
Version: 1.4.0
Summary: 4D Image-based Continuos monitoring of glaciers Evolution with low-cost stereo-cameras and Deep Learning photogrammetry.
Author-email: Francesco Ioli <francesco.ioli@polimi.it>
License: MIT License
        
        Copyright (c) 2022 Francesco Ioli
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/franioli/icepy4d
Keywords: sfm,4d-reconstruction,glaciers,deep-learning
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: opencv-python
Requires-Dist: torch
Requires-Dist: open3d
Requires-Dist: pydegensac
Requires-Dist: scipy
Requires-Dist: exifread
Requires-Dist: tqdm
Requires-Dist: laspy
Requires-Dist: pyyaml
Requires-Dist: easydict
Requires-Dist: kornia
Requires-Dist: lmfit
Provides-Extra: dev
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: bumpver ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pip-tools ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: mkdocs ; extra == 'dev'
Requires-Dist: mkdocs-material ; extra == 'dev'
Requires-Dist: mkdocstrings[python] ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: nbstripout ; extra == 'dev'
Requires-Dist: build ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'

# Welcome to ICEpy4D

4D Image-based Continuos monitoring of glaciers' Evolution with low-cost stereo-cameras and Deep Learning photogrammetry.

`ICEpy4D` is a under active development.

## Installation guide

##### Requirements

- 64-bit Python `>= 3.8` but `< 3.10`
- a NVIDIA graphic card with CUDA capability is strongly reccomended.

##### Create Anaconda environment

```bash
conda create -n icepy4d python=3.8
conda activate icepy4d
```

##### Install gdal for raster manipulation

First, install `gdal`, which is required for building and manipulating orthophotos and DSMs. As the dependacies of `gdal`, are quite strict, it is suggested to install it first with conda. If you don't intend to build orthophotos and DSM, you can skip this step (be careful to remove rasterio from requirements.txt as well in order to avoid unsatisfied dependencies).

```bash
conda update -n base -c conda-forge conda
conda install -c conda-forge gdal
```

Check that `gdal` is correctly installed with:

```bash
python -c "from osgeo import gdal"
```

##### Install Pytorch

Install pythorch following the official guidelines (<https://pytorch.org/get-started/locally/>). Be careful to select the correct CUDA version as that installed on your system.

```bash
pip3 install torch --extra-index-url https://download.pytorch.org/whl/cu116

```

##### Install other required packages

```bash
pip3 install -r requirements.txt
```

##### Various

- If you intend to use Jupyter Notebooks for running main scripts, install jupyterlab with

```bash
pip3 install jupyterlab
```

- When using VScode and Matplotlib, use TkAgg as interactive backend.

##### Install ICEpy4D

Install ICEpy4D package by running from the root folder

```bash
pip install -e .
```

and try to import it

```bash
conda activate icepy4d
python -c "import icepy4d"
```

If no error is given, ICEpy4D is successfully installed and it can be imported with `import icepy4d`


#### For contributing
`bash
pip install -r requirements-dev.txt
pre-commit install
`
