This serves as the final evaluation report for GSoC 2024.
My project for GSoC 2024 is STOFS Subsetting Tool.
Abstract
Before GSoC 24, subsetting xarray datasets was done using either thalassa or ugrid. This method of subsetting was not uniform and sometimes problematic for Stofs-3d (SCHISM) datasets. This project aimed to develop a standard subsetting tool for both ADCIRC and SCHISM datasets, which would improve data accessibility.
Contribution
Over the course of this project, I’ve added support for subsetting STOFS-2D and STOFS-3D datasets, including other dataset formats. I have added example notebooks, example datasets and a comprehensive documentation for the subsetting tool. Towards the end, I’ve helped in developing a reusable selector for the subsetting tool and testing as well.
For detailed contribution, please refer below.
Issues
- Unclosed array
- Example notebooks - Add STOFS dataset
- Add SCHISM compatibility
- Add ADCIRC compatibility
- Add documentation build and website
- Add contribution guide
- Add benchmark examples
- We need test datasets / files!
- Add examples for subsetting STOFS output
- Add examples for subsetting STOFS outputs
- Documentation setup
- Reuse selector
Pull Requests
- Merged - Fixed unclosed array
- Closed - Update xarray version to 2023.10 and add support for Python 3.9
- Reviewed - Stofs 2D support
- Merged - Add contribution guide, benchmarks and datasets
- Merged - Documentation
- Merged - add ‘anon’ parameter and update stofs-2d link
- Open - Reuse selector
After GSoC
For now, xarray-subset-grid can be installed from souce using pip. It could be released as a PyPI package depending on the future maintainer of the project. Providing xarray-subset-grid as a web-api is also one of the goals. The Selector class could be improved further and integrated with fsspec, if needed.
I can help in maintenance of the project for further support and issues.
Acknowledgement
I want to express my deep gratitude to my mentors - Atieh, Matt, Chris and Soroosh.They all gave me assistance, guidance and inspiration during the past few months.