xarray-subset-grid 0.0.1__tar.gz

xarray_subset_grid-0.0.1/.gitattributes

@@ -0,0 +1,3 @@
+# GitHub syntax highlighting
+pixi.lock linguist-language=YAML
+

xarray_subset_grid-0.0.1/.github/workflows/test.yaml

@@ -0,0 +1,50 @@
+
+
+
+name: test
+
+on: [push, pull_request]
+
+env:
+  PIXI_VERSION: v0.47.0
+
+# # Gave up -- could not figure out how to use environment variables :-(
+# env:
+#   # I got these from: https://github.com/prefix-dev/setup-pixi/blob/main/README.md
+#   # they seem to keep it pretty up to date
+#   SETUP_PIXI_VERSION: v0.8.1
+#   PIXI_VERSION: v0.29.0
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        environment: [test310, test311, test312, test313]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: prefix-dev/setup-pixi@v0.8.8
+        with:
+          pixi-version: latest
+          cache: true
+          # auth-host: prefix.dev
+          # auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
+      - run: pixi run --environment ${{ matrix.environment }} test
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: prefix-dev/setup-pixi@v0.8.8
+        with:
+          pixi-version: latest
+          cache: true
+          # auth-host: prefix.dev
+          # auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
+      - run: pixi run --environment test310 lint
+
+
+

xarray_subset_grid-0.0.1/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/jupyter_execute
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+xarray_subset_grid/_version.py
+# pixi environments
+.pixi
+*.egg-info
+
+.ruff_cache/

xarray_subset_grid-0.0.1/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: "2"
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

xarray_subset_grid-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,129 @@
+# Contributors Guide
+
+Interested in improving xarray-subset-grid?
+Have a few minutes to tackle an issue? Or improve the documentation?
+
+## Introduction
+
+First off, thank you for considering contributing to xarray-subset-grid.
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing these open source projects.
+In return, they should reciprocate that respect in addressing your issue,
+assessing changes, and helping you finalize your pull requests.
+So, please take a few minutes to read through this guide.
+
+## What Can I Do?
+
+* Tackle any issues you wish!
+* Contribute code you already have. It does not need to be perfect! We will help you clean
+  things up, test it, etc.
+* Make a tutorial or example of how to do something.
+* Improve documentation of a feature you found troublesome.
+* File a new issue if you run into problems!
+
+## Ground Rules
+
+The goal is to maintain a diverse community that's pleasant for everyone. Please
+be considerate and respectful of others by following our
+[code of conduct](https://github.com/ioos/.github/blob/main/CODE_OF_CONDUCT.md).
+
+* Each pull request should consist of a logical collection of changes.
+  You can include multiple bug fixes in a single pull request,
+  but they should be related.
+  For unrelated changes, please submit multiple pull requests.
+* Do not commit changes to files that are irrelevant to your feature or bug fix
+  (eg: .gitignore).
+* Be willing to accept criticism and work on improving your code; we don't want
+  to break other users' code, so care must be taken not to introduce bugs.
+* Be aware that the pull request review process is not immediate, and is
+  generally proportional to the size of the pull request.
+* PRs with new features, or bugfixes, should not fix existing lints. The more changes in a PR, the harder it will be for the reviewer. We can always send a separate PR with the lint fix later.
+* Avoid making the project "look like your project." We tend to make ourselves at home when writing contributions, but we should avoid renaming things just for renaming sake, moving files around to "organize" the project, or make aesthetic changes without asking the upstream devs first. Such changes, while sometimes desirable, don't bring much value to a PR but do bring extra burden to the reviewers.
+* Do not tackle more than one issue or one feature per PR. While tempting, the smaller the PR, the easier will be to get it merged, reducing merge conflicts, without holding other PRs. Many small ones are always better than a single massive PR.
+* Always state your PR objective clearly in the title "New Feature X", "Bug Fix Y", or "Fixing doc typo".
+* Always add a "longer, but not too long, description of your PR in the body of the first comment.
+* Always write meaningful, short, concise, commit messages. The kind of message your future self will congratulate you.
+* When copying code from other places, like Stack-Overflow (SO), always add the link. That is not only a way to credit the original author of the code, but also add a way to look for the source when debugging. Also, it is not uncommon for a SO answer to be updated with better code.
+* When using AI, also add a comment that you did! And, if possible, add the questions/chat report in a gist and link to it in the PR. While AI can be of great aid, it can also write obfuscated code that is hard to debug if you don't know it was machine generated.
+* Be sure to search the existing issues and PRs before submitting yours. Sometimes these changes are already there and all we need is an extra person on the hill to make the final push. Be that second person and not the one that starts a new hill climb by yourself.
+Always read the development notes when they exist, many questions are already answered there.
+
+## Reporting a bug
+
+The easiest way to get involved is to report issues you encounter when using IOOS Software or by
+requesting something you think is missing.
+
+* Head over to the project issues page.
+* Search to see if your issue already exists or has even been solved previously.
+* If you indeed have a new issue or request, click the "New Issue" button.
+* Fill in as much of the issue template as is relevant. Please be as specific as possible.
+  Include the version of the code you were using, as well as what operating system you
+  are running. If possible, include complete, minimal example code that reproduces the problem.
+
+## Setting up your development environment
+
+We recommend using the [conda](https://conda.io/docs/) or [pixi](https://prefix.dev/) package managers for your Python environments.
+Please take some time to go over the [README](https://github.com/asascience-open/xarray-subset-grid/blob/main/README.md).
+
+Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+(link with instructions) on your system if not already available
+(check with ``git --version`` at the command line.)
+
+Login to your [GitHub](https://github.com) account and make a fork of the
+repository by clicking the "Fork" button.
+Clone your fork of the repository (in terminal on Mac/Linux or git shell/GUI on Windows)
+to the location you'd like to keep it.
+We are partial to creating a ``git_repos`` or ``projects`` directory in our home folder.
+
+```sh
+git clone https://github.com/asascience-open/xarray-subset-grid.git
+```
+
+## Pull Requests
+
+The changes to the code source (and documentation)
+should be made via GitHub pull requests against ``main``,
+even for those with administration rights.
+While it's tempting to make changes directly to ``main`` and push them up,
+it is better to make a pull request so that others can give feedback.
+If nothing else,
+this gives a chance for the automated tests to run on the PR.
+This can eliminate "brown paper bag" moments with buggy commits on the main branch.
+
+Push to your fork and submit a pull request.
+
+## What happens after the pull request
+
+You've made your changes, documented them, added some tests, and submitted a pull request.
+What now?
+
+### Code Review
+
+At this point you're waiting on us. You should expect to hear at least a comment within a
+couple of days. We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted quickly:
+
+* Write tests.
+* Fix any failed lints shown by pre-commit-ci.
+* Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+Pull requests will automatically have tests run by CIs.
+This includes running both the unit tests as well as the code linters.
+The test suite, documentation, style, and more will be checked on various versions of Python with current and legacy packages.
+CIs will run testing on Linux, and Mac, and Windows.
+
+### Merging
+
+Once we're all happy with the pull request, it's time for it to get merged in. Only the
+maintainers can merge pull requests and you should never merge a pull request you have commits
+on as it circumvents the code review. If this is your first or second pull request, we'll
+likely help by rebasing and cleaning up the commit history for you. As your development skills
+increase, we'll help you learn how to do this.
+
+## Further Reading
+
+There are a ton of great resources out there on contributing to open source and on the
+importance of writing tested and maintainable software.
+
+* [How to Contribute to Open Source Guide](https://opensource.guide/how-to-contribute/)
+* [Zen of Scientific Software Maintenance](https://jrleeman.github.io/ScientificSoftwareMaintenance/)

xarray_subset_grid-0.0.1/DevelopmentNotes.txt

@@ -0,0 +1,17 @@
+Development notes:
+
+Various notes you want to know when working on this code.
+
+Data Structures:
+
+Polygons:
+
+Defined as an Nx2 array of (lon, lat) float64
+
+First point is not repeated.
+
+Bounding Box:
+
+A tuple of floats: (min_lon, min_lat, max_lon, max_lat).
+
+

xarray_subset_grid-0.0.1/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Applied Science Associates
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

xarray_subset_grid-0.0.1/PKG-INFO

@@ -0,0 +1,212 @@
+Metadata-Version: 2.4
+Name: xarray_subset_grid
+Version: 0.0.1
+Summary: Subset Xarray datasets in time and space
+Author-email: Matthew Iannucci <matt.iannucci@tetratech.com>, "Christopher H. Barker" <chris.barker@noaa.gov>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, Applied Science Associates
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/asascience-open/xarray-subset-grid
+Keywords: xarray
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: xarray>=2024.6
+Requires-Dist: cf_xarray
+Requires-Dist: cftime
+Requires-Dist: dask
+Requires-Dist: netcdf4
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Provides-Extra: examples
+Requires-Dist: fsspec; extra == "examples"
+Requires-Dist: s3fs; extra == "examples"
+Requires-Dist: zarr; extra == "examples"
+Requires-Dist: matplotlib; extra == "examples"
+Requires-Dist: h5netcdf; extra == "examples"
+Dynamic: license-file
+
+# xarray-subset-grid
+
+Subset Xarray datasets in space while retaining the original grid for complex grid systems.
+
+## Installation
+
+### `pip compatible`
+
+This package is not yet released on pypi, for now install using git:
+
+```
+pip install xarray_subset_grid@git+https://github.com/asascience-open/xarray-subset-grid.git
+```
+
+Or clone the project from git and build / install it from there.
+
+## Usage
+
+This package is designed to be used in conjuction 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
+grid = ds.xsg
+
+# subset to only include temperature
+ds_temp = ds.xsg.subset_vars(['temp'])
+
+# subset by bounding box
+ds_subset_bbox = ds.xsg.subset_bbox([-72, 32, -70, 35])
+
+# or by polygon
+poly = np.array([
+    [-72, 32],
+    [-72, 33], 
+    [-73, 33], 
+    [-73, 31], 
+    [-72, 32],
+])
+ds_subset_poly = ds.xsg.subset_polygon(poly)
+```
+
+For full usage, see the [example notebooks](./examples/)
+
+## Development
+
+### `pip compatible`
+
+First, create a new `virtualenv` and activate it:
+
+```bash
+python -m venv venv
+source venv/bin.activate
+```
+
+Then install the project in local edit mode:
+
+```bash
+pip install -e .
+```
+
+Once installed, the tests can be run: 
+
+```bash
+python -m pytest
+```
+
+Or alternatively run the notebooks in the same `virtualenv`
+
+### `pixi`
+
+
+Learn about `pixi` here: https://prefix.dev/
+
+See the pixi docs for details, but for this setup:
+
+There are three "environments" set up for pixi:
+
+- `default`
+- `dev`
+- `examples`
+
+And two "tasks": 
+
+- `lint`
+- `test`
+
+To run the tests in an isolated environment:
+
+```bash
+pixi run -e dev test
+```
+
+To run a shell to do dev work:
+
+```bash
+pixi shell -e dev
+```
+
+If you want to run the examples (notebooks and al that):
+
+```bash
+pixi shell -e all
+```
+
+That will set up a conda environment with all the develop dependencies.
+
+To run a shell in which you can run the examples:
+
+```bash
+pixi shell -e examples
+```
+To run a shell with everything (dev and example deps:
+
+```bash
+pixi shell -e all
+```
+
+Finally, to when the `pyproject.toml` is updated, be sure to update the `pixi` lockfile:
+
+```bash
+pixi install
+```
+
+### `conda`
+
+If you are using (or want to use) conda, you can install the dependencies with:
+
+```
+conda install --file conda_requirements.txt
+```
+
+That will get you the full set, including what you need to run the examples, etc.
+
+If you need the development tools, you can also install:
+
+```
+conda install --file conda_requirements_dev.txt
+```
+
+(requirements should all be on the conda-forge channel)