Skip to content

Commit 78f7c65

Browse files
2 parents 9c16853 + bfe790a commit 78f7c65

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ conda install -c conda-forge xarray-subset-grid
2323
This package is designed to be used in conjunction with [`xarray`](https://xarray.dev/). Given a [CF Compliant](https://cfconventions.org/) `xarray` dataset named `ds`, this package can be accessed using the `xsg` accessor:
2424

2525
```python
26-
# Get the interprested grid class
26+
import numpy as np
27+
28+
# Get the interpreted grid class
2729
grid = ds.xsg
2830

2931
# subset to only include temperature
@@ -45,7 +47,7 @@ poly = np.array(
4547
ds_subset_poly = ds.xsg.subset_polygon(poly)
4648
```
4749

48-
For full usage, see the [example notebooks](./docs/examples/)
50+
For full usage, see the [example notebooks](https://github.com/ioos/xarray-subset-grid/tree/main/docs/examples) and the [Sphinx documentation on Read the Docs](https://xarray-subset-grid.readthedocs.io/).
4951

5052
## Development
5153

@@ -55,7 +57,9 @@ First, create a new `virtualenv` and activate it:
5557

5658
```bash
5759
python -m venv venv
58-
source venv/bin.activate
60+
source venv/bin/activate # Linux and macOS
61+
# venv\Scripts\activate # Windows cmd
62+
# venv\Scripts\Activate.ps1 # Windows PowerShell
5963
```
6064

6165
Then install the project in local edit mode:

0 commit comments

Comments
 (0)