Metadata-Version: 2.1
Name: DGGSForPoly
Version: 0.2.20
Summary: This package finds the rHEALPIX dggs cells for Polygons using the rhgealpix dggs engine.
Home-page: https://github.com/CSIRO-enviro-informatics/DGGSForPoly
Author: Ross Petridis
Author-email: ross.petridis@csiro.au
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/CSIRO-enviro-informatics/DGGSForPoly/issues
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: Shapely
Requires-Dist: rhealpixdggs

# DGGSForPoly

## poly_fill
Contains a function that returns a set of rHEALPIX DGGS cells that describe the geometry of the inputted polygon. 

The function is built on top of the AusPIX DGGS Engine (https://github.com/GeoscienceAustralia/AusPIX_DGGS/) and makes use of Shapely's Binary Predicates (which is a possible area for future optimisation).

#### Fill Strategies
poly_fill() function has 3 fill_strategies:   
    1) poly_fully_covered_by_cells -  returns a set of cells that completly encapsulating the polygon -> over estimates area   
    2) centroids_in_poly -  returns a set of cells whose centroids are contained by the polygon.   
    3) cells_fully_contained_in_poly -  returns a set of cells completely encapsulated *by* the Polygon -> under estimates area   

## cell_operations
Contains modules for calculating area of cell list and for visualising sets of cells and the polygon they represent. poly_fill utilises some functions in the helper module.  

## Setting up environment

```
$ python3 -m venv .venv
$ source .venv/bin/activate
# or on Windows: source .venv/Scripts/activate
$ python setup.py install
```

Include testing
```
$ pip install -U pytest
$ pytest
```

