|
1 | 1 | # rasterix: Raster tricks for Xarray |
2 | 2 |
|
3 | | -[](https://github.com/dcherian/rasterix/actions) |
| 3 | +[](https://github.com/xarray-contrib/rasterix/actions) |
4 | 4 | [](https://rasterix.readthedocs.io/en/latest/?badge=latest) |
5 | 5 | [](https://pypi.org/project/rasterix/) |
6 | 6 | [](https://anaconda.org/conda-forge/rasterix) |
7 | 7 |
|
8 | | -<img src="rasterix.png" width="300"> |
| 8 | +<img src="_static/rasterix.png" width="300"> |
9 | 9 |
|
10 | 10 | This WIP project contains tools to make it easier to analyze raster data with Xarray. |
11 | | - |
12 | | -The intent is to provide reusable building blocks for the many sub-ecosystems around: e.g. rioxarray, odc-geo, etc. |
13 | | - |
14 | | -## Contents |
15 | | - |
16 | 11 | It currently has two pieces. |
17 | 12 |
|
18 | | -### 1. RasterIndex |
19 | | - |
20 | | -See `src/ rasterix/raster_index.py` and `notebooks/raster_index.ipynb` for a brief demo. |
| 13 | +1. `RasterIndex` for indexing using the affine transform recorded in GeoTIFFs. |
| 14 | +1. Dask-aware rasterization wrappers around `exactextract`, `rasterio.features.rasterize`, and `rasterio.features.geometry_mask`. |
21 | 15 |
|
22 | | -### 2. Dask-aware rasterization wrappers |
23 | | - |
24 | | -See `src/rasterix/rasterize.py` for dask-aware wrappers around [`exactextract`](https://github.com/dcherian/rasterix/blob/ec3f51e60e25aa312e6f48c4b22f91bec70413ed/rasterize.py#L165), [`rasterio.features.rasterize`](https://github.com/dcherian/rasterix/blob/ec3f51e60e25aa312e6f48c4b22f91bec70413ed/rasterize.py#L307), and [`rasterio.features.geometry_mask`](https://github.com/dcherian/rasterix/blob/ec3f51e60e25aa312e6f48c4b22f91bec70413ed/rasterize.py#L472). |
25 | | - |
26 | | -This code is likely to move elsewhere! |
| 16 | +Our intent is to provide reusable building blocks for the many sub-ecosystems around: e.g. `rioxarray`, `odc.geo`, etc. |
27 | 17 |
|
28 | 18 | ## Installing |
29 | 19 |
|
30 | | -### PyPI |
31 | | - |
32 | 20 | `rasterix` alpha releases are available on pypi |
33 | 21 |
|
34 | 22 | ``` |
35 | 23 | pip install rasterix |
36 | 24 | ``` |
37 | | - |
38 | | -## Developing |
39 | | - |
40 | | -1. Clone the repo |
41 | | - ``` |
42 | | - git remote add upstream [email protected]:dcherian/rasterix.git |
43 | | - cd rasterix |
44 | | - ``` |
45 | | -1. [Install hatch](https://hatch.pypa.io/1.12/install/) |
46 | | -1. Run the tests |
47 | | - ``` |
48 | | - hatch env run --env test.py3.13 run-pytest # Run the tests without coverage reports |
49 | | - hatch env run --env test.py3.13 run-coverage-html # Run the tests with an html coverage report |
50 | | - ``` |
0 commit comments