Skip to content

Commit 213f7ca

Browse files
authored
DOC: add installation instructions for release (#38)
1 parent fc33706 commit 213f7ca

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

Readme.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,27 @@
44
55
Xvec combines [Xarray](http://xarray.pydata.org) n-D arrays and [shapely 2](https://shapely.readthedocs.io/en/latest/) planar vector geometries to create a support for vector data cubes in Python. See [this post](https://r-spatial.org/r/2022/09/12/vdc.html) by Edzer Pebesma on an introduction of the concept or the introduction of their implementation in Xvec in our [documentation](https://xvec.readthedocs.io/en/latest/intro.html).
66

7+
## Project status
8+
9+
The project is in the early stage of development and its API may still change.
10+
711
## Installing
812

9-
Xvec is not released yet and can be installed from GitHub.
13+
You can install Xvec from PyPI using `pip` or from conda-forge using `mamba` or `conda`:
14+
15+
```sh
16+
pip install xvec
17+
```
18+
19+
Or (recommended):
20+
21+
```sh
22+
mamba install xvec -c conda-forge
23+
```
24+
25+
### Development version
26+
27+
The development version can be installed from GitHub.
1028

1129
```sh
1230
pip install git+https://github.com/xarray-contrib/xvec.git

0 commit comments

Comments
 (0)