Pygeoutils

-------------------

Breaking Changes
~~~~~~~~~~~~~~~~
- Append "Error" to all exception classes for conforming to PEP-8 naming conventions.

-------------------

Breaking Changes
~~~~~~~~~~~~~~~~
- Set the minimum supported version of Python to 3.8 since many of the
dependencies such as ``xarray``, ``pandas``, ``rioxarray`` have dropped support
for Python 3.7.
- Bump min versions of ``rioxarray`` to 0.10 since it adds reading/writing GCPs.

Internal Changes
~~~~~~~~~~~~~~~~
- Use `micromamba <https://github.com/marketplace/actions/provision-with-micromamba>`__
for running tests
and use `nox <https://github.com/marketplace/actions/setup-nox>`__
for linting in CI.

-------------------

New Features
~~~~~~~~~~~~
- Add support for passing a custom bounding box in the ``Coordinates`` class.
The default is the bounds of ``EPSG:4326`` to retain backward compatibility.
This new class parameter allows a user to check if a list of coordinates
is within a custom bounding box. The bounds should be the ``EPSG:4326`` coordinate
system.
- Add a new function called ``geometry_list`` for converting a list of
multi-geometries to a list of geometries.

-------------------

Internal Changes
~~~~~~~~~~~~~~~~
- Write ``nodata`` attribute using ``rioxarray`` in ``geotiff2xarray`` since the
clipping operation of ``rioxarray`` uses this value as fill value.

Bug Fixes
~~~~~~~~~
- In the ``break_lines`` function, convert ``MultiLineString`` into
``LineString`` since ``shapely.ops.substring`` only accepts ``LineString``.

-------------------

New Features
~~~~~~~~~~~~
- Add a function called ``break_lines`` for breaking lines at given points.
- Add a function called ``snap2nearest`` for snapping points to the nearest
point on a line with a given tolerance. It accepts a ``geopandas.GeoSeries`` of
points and a ``geopandas.GeoSeries`` or ``geopandas.GeoDataFrame`` of lines. It
automatically snaps to the closest lines in the input data.

-------------------

New Features
~~~~~~~~~~~~
- Add a new class called ``GeoBSpline`` that generates B-splines from a set of
coordinates. The ``spline`` attribute of this class has five attributes:
``x`` and ``y`` coordinates, ``phi`` and ``radius`` which are curvature and
radius of curvature, respectively, and ``distance`` which is the total distance
of each point along the B-spline from the starting points.
- Add a new class called ``Coordinates`` that validates a set of lon/lat coordinates.
It normalizes longitudes to the range [-180, 180) and has a ``points`` property
that is ``geopandas.GeoSeries`` with validated coordinates. It uses spatial indexing
to speed up the validation and should be able to handle large datasets efficiently.
- Make ``transform2tuple`` a public function.

Internal Changes
~~~~~~~~~~~~~~~~
- The ``geometry`` and ``geo_crs`` arguments of ``gtiff2xarray`` are now optional.
This is useful for cases when the input ``GeoTiff`` response is the results of
a bounding box query and there is no need for a geometry mask.
- Replace the missing values after adding geometry mask via ``xarray_geomask`` by the
``nodatavals`` attribute of the input ``xarray.DataArray`` or ``xarray.Dataset``.
Therefore, the data type of the input ``xarray.DataArray`` or ``xarray.Dataset``
is conserved.
- Expose ``connectivity`` argument of ``rasterio.features.shapes`` function in
``xarray2geodf`` function.
- Move all private functions to a new module to make the main module less cluttered.