Skip to content

Commit a612017

Browse files
authored
Rename to xarray-contrib; clean up README (#54)
1 parent bfe732a commit a612017

File tree

3 files changed

+8
-34
lines changed

3 files changed

+8
-34
lines changed

README.md

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,24 @@
11
# rasterix: Raster tricks for Xarray
22

3-
[![GitHub Workflow CI Status](https://img.shields.io/github/actions/workflow/status/dcherian/rasterix/test.yml?branch=main&logo=github&style=flat)](https://github.com/dcherian/rasterix/actions)
3+
[![GitHub Workflow CI Status](https://img.shields.io/github/actions/workflow/status/xarray-contrib/rasterix/test.yml?branch=main&logo=github&style=flat)](https://github.com/xarray-contrib/rasterix/actions)
44
[![Documentation Status](https://readthedocs.org/projects/rasterix/badge/?version=latest)](https://rasterix.readthedocs.io/en/latest/?badge=latest)
55
[![PyPI](https://img.shields.io/pypi/v/rasterix.svg?style=flat)](https://pypi.org/project/rasterix/)
66
[![Conda-forge](https://img.shields.io/conda/vn/conda-forge/rasterix.svg?style=flat)](https://anaconda.org/conda-forge/rasterix)
77

8-
<img src="rasterix.png" width="300">
8+
<img src="_static/rasterix.png" width="300">
99

1010
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-
1611
It currently has two pieces.
1712

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`.
2115

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.
2717

2818
## Installing
2919

30-
### PyPI
31-
3220
`rasterix` alpha releases are available on pypi
3321

3422
```
3523
pip install rasterix
3624
```
37-
38-
## Developing
39-
40-
1. Clone the repo
41-
```
42-
git remote add upstream git@github.com: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-
```
File renamed without changes.

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@
5656
codeautolink_concat_default = True
5757

5858
extlinks = {
59-
"issue": ("https://github.com/dcherian/rasterix/issues/%s", "GH#%s"),
60-
"pr": ("https://github.com/dcherian/rasterix/pull/%s", "PR#%s"),
59+
"issue": ("https://github.com/xarray-contrib/rasterix/issues/%s", "GH#%s"),
60+
"pr": ("https://github.com/xarray-contrib/rasterix/pull/%s", "PR#%s"),
6161
}
6262

6363
templates_path = ["_templates"]
@@ -122,7 +122,7 @@
122122
)
123123

124124
html_context = {
125-
"github_user": "dcherian",
125+
"github_user": "xarray-contrib",
126126
"github_repo": "rasterix",
127127
"github_version": "main",
128128
"doc_path": "doc",

0 commit comments

Comments
 (0)