# SciPy 2019 Xarray Sprint
![image alt][reference][xarray]
(http://xarray.pydata.org/en/stable/_static/dataset-diagram-logo.png)

## Important links:

- [Code of conduct](https://github.com/pydata/xarray/blob/master/CODE_OF_CONDUCT.md) - **All sprint participants must read and follow!**
- Xarray repo: <https://github.com/pydata/xarray>
- Xarray docs: <http://xarray.pydata.org/en/latest/>
- [Contributor Guide](http://xarray.pydata.org/en/latest/contributing.html) - **All sprint participants must read this and set up their development environment according to the instructions!**
- [Xarray Internals](http://xarray.pydata.org/en/latest/internals.html)
- [Xarray Roadmap](http://xarray.pydata.org/en/latest/roadmap.html)
- Blog posts on Xarray development
- [Supporting New Xarray Contributors](https://medium.com/pangeo/supporting-new-xarray-contributors-6c42b12b0811) - This has a long list of beginner, intermediate, and advanced issues
- [Thoughts on the state of Xarray within the broader scientific Python ecosystem](https://medium.com/pangeo/thoughts-on-the-state-of-xarray-within-the-broader-scientific-python-ecosystem-5cee3c59cd2b)

## Attendees

- Ryan Abernathey / rabernat - Xarray core dev, sprint leader
- Stephan Siemen / StephanSiemen - atmospheric data & docs/examples
- Zach Bruick / zbruick - Meteorology, docs
- Philippe Delandmeter / delandmeterp - Lagrangian modelling, [issue #3041](https://github.com/pydata/xarray/issues/3041)
- Zach Griffith / zdgriffith - atmospheric data & docs / bugs / features
- Brian Bonnlander / bonnland - xarray development
- Rob Hetland / hetland - ROMS ocean model examples using xarray and xgcm
- David Mertz / DavidMertz - [issue #2891](https://github.com/pydata/xarray/issues/2891)
- Mike McCann / MBARIMike - Discrete Sampling Geometry data plotting examples [PR #3111](https://github.com/pydata/xarray/pull/3111)
- Rick Russotto / rdrussotto - [issue #2078](https://github.com/pydata/xarray/issues/2078)
- Your name / your github - your focus for the sprint

## Stuff to work on

### Become an Xarray User

We believe Xarray is underutilized within the SciPy ecosystem. Xarray can solve many common problems related to nd-arrays. One of the easiest ways to participate in the sprint is to just *use Xarray for your own project / library*. Experienced Xarray users are standing by to help you!

### Extend Xarray

If you want domain-specific functionality that is out of scope for the Xarray library proper, consider implementing and [Xarray accessor](http://xarray.pydata.org/en/latest/internals.html#extending-xarray), which allows you to inject your own methods and attributes into Xarray's namespace.

### Documentation

Documentation is a high priority for this sprint. It's also a good place for new contributors to start. There are many, many [documentation-tagged issues](https://github.com/pydata/xarray/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation)

We are also keen on developing an expanded set of tutorials / examples / cookbook. (This will be Ryan's main focus.) We can track this via the [cookbook issue](https://github.com/pydata/xarray/issues/1790).

For the documentation, we are currently using to the [`scipy19-docs`](https://github.com/pydata/xarray/tree/scipy19-docs) branch so we can track the doc builds on [Read The Docs](http://xarray.pydata.org/en/scipy19-docs/roadmap.html). All documentation-related PRs should be against this branch, rather than `master`. The examples live in the `doc/examples` directory of the xarray repo.

Instructions for doing this:

git checkout -b my-scipy-feature-branch
git fetch upstream
git rebase upstream/scipy19-docs
# make changes, git add, git commit, etc.
git push origin my-scipy-feature-branch
# open pull request against scip19-docs branch

### Fix Bugs and Add Features

This is the more traditional cateogy of sprint activity. We have plenty of [good first issues](https://github.com/pydata/xarray/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).

As a meta-issue, like many projects, we struggle with maintenance of our issue tracker. Any help triaging / closing / labeling issues would be amazing!

#### Hardish Core Stuff

- **Indexes**: One issue that is currently blocking lots of forward development is a need to refactor some internals to support more flexible indexes ([issue 1603](https://github.com/pydata/xarray/issues/1603)). In that issue, there is a clear check list to follow. If we could manage to move the dial on this, we would have a major impact.

- **Arrays**: Another exciting opportunity is to plug arbitrary numpy-like arrays into Xarray (e.g. sparse, CuPy, etc.). We are tracking related issues with the [`arrays` label](https://github.com/pydata/xarray/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Aarrays+).