Metadata-Version: 2.1
Name: sertit
Version: 1.3.9
Summary: SERTIT python library for generic tools
Home-page: UNKNOWN
Author: Rémi BRAUN
Author-email: dev-sertit@unistra.fr
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/sertit/sertit-utils/issues/
Project-URL: Documentation, https://sertit.github.io/sertit-utils/sertit/
Project-URL: Source Code, https://github.com/sertit/sertit-utils
Description: Library gathering functions for all SERTIT's projects.
        
        Find the API documentation [**here**](https://sertit.github.io/sertit-utils/).
        
        # Installing
        
        For installing this library to your environment, please type this:
        
        - in your console: `pip install sertit[full]`
        
        `[full]` will allow you to use the whole library, but you will need to install also`rioxarray` and `geopandas`
        (with GDAL installation issues on Windows, so please install them from wheels that you can
        find [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#rasterio)).
        
        However, if you do not need everything, you can type instead:
        
        - *nothing*, and you won't need `rasterio`, `rioxarray` or `geopandas`: `pip install sertit --extra-index-url ...`
        - `[vectors]`, and you won't need `rasterio` or `rioxarray`: `pip install sertit[vectors] --extra-index-url ...`
        - `[rasters]`, and you won't need `rioxarray`: `pip install sertit[rasters] --extra-index-url ...`
        - `[rasters_rio]`: `pip install sertit[rasters_rio] --extra-index-url ...`
        - `[colorlog]`: `pip install sertit[colorlog] --extra-index-url ...` to have `colorlog` installed
        
        # What is in it ?
        ## Files
        
        File gathering file-related functions:
        
        - paths
        - Create archive
        - Add folder to zip file
        - file extraction
        - file name
        - copy/remove
        - find files
        - JSON/pickles
        - hash
        
        ## Logs
        - Init simple logger
        - Create complex logger (file and stream + color)
        - Shutdown logger
        
        ## Misc
        - Function on lists: convert a list to a dict, remove empty values...
        - Function on dicts: nested set, check mandatory keys, find by key
        - Run a command line
        - Get a function name
        - Test if in docker
        - Change current directory (`cd`) as a context manager
        
        ## Strings
        - Conversion from string to bool, logging level, list, list of dates...
        - Convert the string to be usable in command line
        - Case conversion (`snake_case` to/from `CamelCase`)
        
        ## Vectors
        - Load an AOI as WKT
        - Get UTM projection from lat/lon
        - Manage bounds and polygons
        - Get `geopandas.Geodataframe` from polygon and CRS
        
        ## Rasters and rasters_rio
        Basically, these functions are overloads of rasterio's functions:
        
        - Get extent and footprint of a raster
        - Read/write overload of rasterio functions
        - Masking and cropping with masked array
        - Collocation (superimpose)
        - Sieving
        - Vectorization and get nodata vector
        - Merge rasters (as GTiff and VRT)
        - Get the path of the BEAM-DIMAP image that can be read by rasterio
        - Manage bit arrays
        
        The main difference between the two is that `rasters` outputs one `xarray` variable
        when `rasters_rio` outputs `numpy.ma.masked_arrays` + `dict` for the raster array and its metadata.
        
        ## Network
        - Standard [Exponential Backoff](https://en.wikipedia.org/wiki/Exponential_backoff) algorithm
        
        ## SNAP
        - Function converting bytes to SNAP understanding
        - Function creating a SNAP optimized commande line
        
        # Documentation
        
        An HTML documentation is provided to document the code.
        It can be found:
        
        - online ([here](https://sertit.github.io/sertit-utils/)),
        - on git, in `docs`.
          To consult it, just open the `index.html` file in a web browser (you need first to clone this project)
          To generate the HTML documentation, just type `pdoc sertit -o docs\html -f --html -c sort_identifiers=False`
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: colorlog
Provides-Extra: full
Provides-Extra: rasters_rio
Provides-Extra: rasters
Provides-Extra: vectors
