diff --git a/docs/source/intro.rst b/docs/source/intro.rst index a351755..307b4e0 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -48,6 +48,31 @@ Finally, :py:mod:`xagg` allows for direct exporting of the aggregated data in se Best of all, :py:mod:`xagg` is flexible. Multiple variables in your dataset? :py:mod:`xagg` will aggregate them all, as long as they have at least ``lat/lon`` dimensions. Fields in your shapefile that you'd like to keep? :py:mod:`xagg` keeps all fields (for example FIPS codes from county datasets) all the way through the final export. Weird dimension names? :py:mod:`xagg` is trained to recognize all versions of "lat", "Latitude", "Y", "nav_lat", "Latitude_1"... etc. that the author has run into over the years of working with climate data; and this list is easily expandable as a keyword argument if needed. +How to support `xagg` +======================================= +The easiest way to support `xagg` is to star the `GitHub repository `_ and spread the word! + +Please also consider citing `xagg` if you use it in your research. The preferred citation can be found at the "Cite this repository" button in the About section on the top right of the `GitHub repository `_. + +`xagg`, like much of open-source software, is a volunteer-run effort. It means a lot to the developers if you reach out and tell us that you're using our software, how it's helped you, and how it can be improved - it makes the long hours fixing bugs feel that much more worth it. (If you're feeling particularly generous, the lead developer would not say no to additional thanks through [contributions to his tea fund through Ko-Fi](ko-fi.com/ks905383) ;) ) + +Getting Help and Contributing +======================================= +If you have any questions about how to use `xagg`, please ask them in the `GitHub Discussions `_ forum! + +If you spot a bug (`xagg` not working as advertised), please `open an issue `_ if it hasn't yet been raised (or comment on an existing one if you see it listed already). To make sure the issue gets solved as quickly as possible: +- Include a `minimally reproducible example `_ that triggers the bug +- Include a copy of your environment (for example, the output of `conda list`) in which the bug occurred + +If you'd like to go the extra mile and help us fix the bug, feel free to `contribute a pull request `_! We ask that any PR: +- Follows a standard development workflow, like `this `_ one. +- If fixing a bug, `includes unit tests `_ that fail when confronted with the original bug. GitHub Actions are set up to automatically run all tests in `xagg/tests/` upon a push. + +If there's a feature that you'd like `xagg` to have, please start a Discussion in the [GitHub Discussions](https://github.com/ks905383/xagg/discussions) forum, or implement it yourself in a pull request. + +For more information on contributing in general, the `contribution guidelines `_ to the `xarray` package are a great starting point (not everything will be directly relevant to `xagg`, but much of this guide is generally relevant!). + + Use cases ======================================= diff --git a/docs/source/tips.rst b/docs/source/tips.rst index 4dd4863..3d5bf9f 100644 --- a/docs/source/tips.rst +++ b/docs/source/tips.rst @@ -1,4 +1,4 @@ -Tips +Tips ####################################### Silencing status updates @@ -61,6 +61,9 @@ Once you have created a :py:class:`weightmap`, the following code will create a # Plotting the first polygon in the polygon `gdf` weightmap.diag_fig(0,ds) +IndexErrors in :py:meth:`xa.pixel_overlaps` +------------------------------------------------------------ +If you're running into an `IndexError` when running :py:meth:`xa.pixel_overlaps` (e.g., `IndexError: too many indices for array: array is 1-dimensional, but 3 were indexed`), try reprojecting the input :py:meth:`geodataframe` to `'EPSG:4326'` before running :py:meth:`xa.pixel_overlaps`. See `here `_ for more discussion on this issue.