Rasterio

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

New features:

- A new `mask_flag_enums` attribute has been added to dataset objects (881).
- Support for complex data types has been enabled (714).

Bug fixes:

- Reduce log level when trying to identify a CRS as an EPSG code (905).
- Acquire GIL when executing the error handler (903).
- Raster data I/O involving ndarray views has now been corrected (900, 901).
- Support for single band index in `sample()`, which was advertised in the
docstring but not implemented, has been added (862).
- The rio-overview CLI command no longer opens datasets in 'r+' mode when
listing overviews (with the `--ls` option) (885).
- Implicit JPEG overviews for JPEG-compressed GeoTIFF files have been disabled
in Rasterio's default environment, which means decimation is slower but
shows fewer JPEG compression artifacts (884).

Refactoring:

- Data type-specific functions such as `io_uint8()` have been eliminated from
the private `_io` module and replaced by generic `io_band()`,
`io_multi_band()`, and `io_multi_mask()` functions (901).

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

Documentation:

- New introduction, guidance on switching from GDAL's Python bindings and much
more.

Breaking changes:

- The sense of rio-warp's `--bounds` options has been changed from source
bounds to destination bounds (549).
- Extracted Rasterio's public dataset classes into `rasterio.io` (743).
- All Rasterio functions with will raise an exception if a GDAL style
geotransform sequence is passed as `transform`.
- The `affine` attribute of dataset objects is deprecated.
- The `affine` member of dataset `profile` has been removed.
- The `rasterio.drivers()` context manager has been removed. It is replaced by
`rasterio.Env()`.
- The `read_band()` method of dataset objects has been removed. It is replaced
by `read()`.
- The `read_mask()` method of dataset objects has been removed. It is replaced
by `read_masks()`.
- `get_data_window()`, `window_union()`, `window_intersection()`, and
`windows_intersect()` have been removed from the `rasterio` module. They
have been moved to `rasterio.windows`.
- The `rasterio.tool` module has been removed. Its functions have been
relocated to `rasterio.plot` and `rasterio.rio.insp`.
- The `rasterio.tools` module has been removed. Its functions have been
relocated to `rasterio.mask` and `rasterio.merge`.
- The `rasterio.warp.RESAMPLING` enum has been replaced by
`rasterio.warp.Resampling`.
- The signatures of `rasterio.features.sieve()` and
`rasterio.features.rasterize()` have been changed: the `output` argument
is deprecated and is replaced by `out`.
- In the CLI, the `-o` option no longer causes existing output files to be
overwritten (751).

New features:

- Added `descriptions` and `units` attributes to dataset objects, exposing
the descriptions and units of dataset bands (850, 851).
- Creation of a `Window` class to abstract Rasterio's window selection
tuples (759).
- Performance of `reproject()` has been increased by using an approximate
transformer as with gdal_translate (569).
- `Band` objects may now represent one or more dataset bands and multiband
reprojection of imagery kept in a GDAL dataset is now possible (569).

Bug fixes:

- `rasterize()` now checks that the `out_shape` is 2D before continuing (847).
- Named AWS credential profiles are now properly set up up in the main CLI
command's environment (838).

Refactoring:

- In the CLI, a GDAL environment is now configured by the top level command
and then passed in a Click context to subcommands (841).
- Removal of redundant copies of GDAL geotransform detection code (828).
- Window methods of dataset objects have been extracted into functions of
a new `rasterio.windows` module (803).

Known bugs:

- `warp.project()` and rio-warp may lose one or more columns of data when
resampling to lower resolution (853).

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

Bug fixes:

- rio-merge now copies colormaps to output files (774, 778).
- The correct `--force-overwrite` and `--output` usage is now provided in the
case of a `FileOverwriteError` (750).
- Passing undefined CRS to `reproject` no longer causes a segfault (749).
- GDAL's invert projection check is always used by default in reprojecting
(780).
- Forward slashes are always used for GDAL VSI paths (`/vsizip/` etc) instead
of `os.path.sep` (754, 789).

Documentation:

- Contributing guidelines have been added (701).
- Axis order has been corrected in image processing doc (700).
- A framework for comprehensive documentaton has been created (713, 723,
729, 737, 738, 739, 740, 748, 756, 760).

New features:

- `--src-nodata` and `--dst-nodata` options for rio-warp (746).
- `read()` and `read_masks()` take an `out_shape` argument for decimated reads
(761).
- Color interpretation of bands added to rio-info output (766).
- Dataset objects have a new per-dataset mask property: `dataset_mask` (716).
- Utility functions for rehaping and plotting arrays have been added to
`rasterio.plot` (718, 765).
- New `CRS` class like our old crs dicts, but with methods attached (736,
770).

Packaging:

- setup.py has new install extras: '[plot]', and '[all]' (744).

Refactoring:

- We've standardized on `import numpy as np` (727, 738, 740) throughout the
project.
- The `five` module has been renamed to `compat` (745).

Testing:

- More coverage, more xfailing tests to mark known bugs (742, 762, 753,
773, 782).

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

- Bug fix: restore support for URI-like GDAL dataset names such as
'NETCDF:foo:bar' (695).
- Bug fix: ensure GDAL environment is initialized for `transform_bounds()` as
well as the other functions in `rasterio.warp` (694). In implementation, we
have done this with a function decorator.

-------------------------
- Bug fix: added rasterfill.cpp to MANIFEST.in so it is included in source
distributions no matter the build system's GDAL version (690).

-------------------
- Requirements: affine requirement upped to >=1.3.0 (430).
- Bug fix: passing an empty JSON object to `crs.from_string()` raises CRSError
instead of passing silently (628, 642).
- Bug fix: GDAL errors are no longer written to stderr; we no longer undefine
error handlers (649, 658).
- Bug fix: the Rasterio library only configures a NullHandler, applications
must configure their own handlers to see Rasterio's log messages (649,
658).
- Bug fix: AWS credentials are only sought by Rasterio when s3:// URLs are
passed to `rasterio.open()` (650, 665).
- Bug fix: window comparison functions now raise a ValueError when windows do
not intersect instead of returning an empty sequence (651, 656, 662).
- Bug fix: upgrade from deprecated Numpy usage in `read()` by explicitly
converting window offsets to ints (678, 680).
- Refactoring: window comparison functions may now take a variable number of
windows as positional arguments in addition to a sequence of windows.
- Refactoring: logging is much finer grained now because we've changed to the
`logger = logging.getLogger(__name__)` pattern throughout Rasterio (649,
658).
- Refactoring: replaced old `drivers()` implementation with a new `Env` class
and more consistent usage of it through the library and command line
interface (665, 682).