Skip to content

Commit b65ed4a

Browse files
committed
Improve readme
1 parent 4b80277 commit b65ed4a

File tree

1 file changed

+55
-1
lines changed

1 file changed

+55
-1
lines changed

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,57 @@
11
# xarray-enmap
22

3-
An xarray backend to read EnMAP archives.
3+
An xarray backend to read the data archives provided by the EOWEB data portal
4+
of the [EnMAP](https://www.enmap.org/) mission.
5+
6+
## Installation
7+
8+
### With mamba or conda
9+
10+
`mamba install xarray-enmap`
11+
12+
or
13+
14+
`conda install xarray-enmap`
15+
16+
### With pip
17+
18+
`pip install xarray-enmap`
19+
20+
### Development install from the git repository
21+
22+
Clone the repository and set the current working directory:
23+
24+
```bash
25+
git clone https://github.com/bcdev/xarray-enmap.git
26+
cd xarray-enmap
27+
```
28+
29+
Install the dependencies with mamba or conda:
30+
31+
```bash
32+
mamba env create
33+
mamba activate xarray-enmap
34+
```
35+
36+
Install xarray-enmap itself:
37+
38+
```bash
39+
pip install --no-deps editable .
40+
```
41+
42+
## Usage
43+
44+
```
45+
import xarray as xr
46+
47+
enmap_dataset = xr.open_dataset(
48+
"/path/to/enmap/data/filename.tar.gz",
49+
engine="enmap"
50+
)
51+
```
52+
53+
The path can be to either a `.tar.gz` archive as provided by the EnMAP portal,
54+
or to a directory containing the extracted archive contents.
55+
56+
If the archive or directory contains multiple EnMAP products, xarray-enmap
57+
will open only the first. This will be improved in a future version.

0 commit comments

Comments
 (0)