Skip to content

docs: fix README usage path, typos, and doc links #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Divyateja2709 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix README usage path, typos, and doc links #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ conda install -c conda-forge xarray-subset-grid
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:

```python
# Get the interprested grid class
import numpy as np

# Get the interpreted grid class
grid = ds.xsg

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

For full usage, see the [example notebooks](./examples/)
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/).

## Development

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

```bash
python -m venv venv
source venv/bin.activate
source venv/bin/activate # Linux and macOS
# venv\Scripts\activate # Windows cmd
# venv\Scripts\Activate.ps1 # Windows PowerShell
```

Then install the project in local edit mode:
Expand Down