https://github.com/cwhite911/foss4gna-2025-workshop
GRASS Addon Development with Python
https://github.com/cwhite911/foss4gna-2025-workshop
geoprocessing grass grass-addon grass-gis grass-gis-addons
Last synced: 3 months ago
JSON representation
GRASS Addon Development with Python
- Host: GitHub
- URL: https://github.com/cwhite911/foss4gna-2025-workshop
- Owner: cwhite911
- License: gpl-3.0
- Created: 2025-10-28T01:16:49.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-10-28T02:45:10.000Z (7 months ago)
- Last Synced: 2025-10-28T04:09:14.291Z (7 months ago)
- Topics: geoprocessing, grass, grass-addon, grass-gis, grass-gis-addons
- Homepage: https://www.foss4gna.org/schedule
- Size: 19.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FOSS4GNA-2025-workshop
Workshop Participant Level: Advanced
Learn to develop [GRASS addons](https://github.com/OSGeo/grass-addons) with
Python! Together, we will develop a parallelized custom addon with Python,
command line, and graphical user interfaces. [GRASS](https://grass.osgeo.org/)
works as a powerful geospatial processing engine that works on a small laptop to
a huge supercomputer. GRASS also makes it easy to move from using a
[graphical user interface (GUI)](https://grass.osgeo.org/grass85/manuals/helptext.html)
to command line interface or
[Python API](https://grass.osgeo.org/grass85/manuals/python_intro.html).
During this workshop we will develop a GRASS addon exploring the various
[GRASS Python modules](https://grass.osgeo.org/grass-devel/manuals/libpython/index.html),
tooling, and best practice required to produce high quality open source software.
The bonus material for this workshop will also cover tools written in C.
## Prerequisites
To get the most out of this workshop, basic Python and GIS experience is
recommended. The workshop will use an online environment, so no software
installation on laptops is required from participants.
## Learning Objectives
By the end of this workshop, participants will be able to:
1. Explain GRASS fundamentals including:
- available engine interfaces
- how to manage geospatial data with projects,
- and how to leverage computational region for effient processing
2. Use GRASS Python modules to develop geospatial processing tools
3. Describe the structure of a GRASS addon and community best practices for development
4. Develop command line and graphical user interfaces for GRASS addons
5. Be ready to contribute GRASS addons to the community repository :green_heart:
## Workshop Outline
[](https://github.com/codespaces/new?repo=cwhite911%2FFOSS4GNA-2025-workshop&ref=main&template=true)
### Part 1: GRASS Fundamentals, 45 min
- [Intro to GRASS](https://grass.osgeo.org/grass-devel/manuals/index.html)
- [GRASS scripting with Python](./workshop/part_1_grass/Scripting_with_GRASS.ipynb)
- [Write your first GRASS script](./workshop/part_1_grass/my_grass_script.py)
#### _10 min Break 1_
### Part 2: From GRASS scripts to GRASS addons, 45 min
- [What is a GRASS addon and why write one?](./workshop/part_2_addons/Intro.md)
- [The development environment](.workshop/part_2_addons/Addon_Structure.md)
- Addon structure, best practices and standardized options and flags
- Local testing and debugging
- [How to contribute an addon](./workshop/part_2_addons/Developing_an_addon.md)
#### _10 min Break 2_
### Part 3: Hands-On Project, 45 min
- Build a parallelized GRASS addon with CLI and GUI
- Testing and packaging
- Submitting to grass-addons
### Conclusion, remaining time
- Wrap-up
- Bonus: C Addon Overview
- Bonus: AI-assisted coding for GRASS addon development the good, the bad, and
the ugly.
## Resources
- [GRASS Website](https://grass.osgeo.org/)
- [GRASS Python Documentation](https://grass.osgeo.org/grass-devel/manuals/libpython/index.html)
### GitHub Repositories
- [grass](https://github.com/OSGeo/grass)
- [grass-addons](https://github.com/OSGeo/grass-addons)
- [grass-addon-cookiecutter](https://github.com/OSGeo/grass-addon-cookiecutter)
### Developer Docs
- [GRASS Python Introduction](https://grass.osgeo.org/grass-devel/manuals/python_intro.html)
- [grass.tools](https://grass.osgeo.org/grass-devel/manuals/libpython/grass.tools.html)
provides a Python interface to GRASS tools,
- [grass.script](https://grass.osgeo.org/grass-devel/manuals/libpython/script_intro.html)
handles GRASS projects and sessions in Python,
- [grass.pygrass](https://grass.osgeo.org/grass-devel/manuals/libpython/pygrass_index.html)
enables a fine-grained access to the GRASS data structures.
- [GRASS 8 Programmer's Manual](https://grass.osgeo.org/programming8/)
- [Standard Parser Options][parser] standard option structure
- [GRASS Programming Style Guide](https://grass.osgeo.org/grass85/manuals/style_guide.html)
[parser]: https://grass.osgeo.org/grass85/manuals/parser_standard_options.html
## Instructors
- [Corey White](https://github.com/cwhite911)
- [Caitlin Haedrich](https://github.com/chaedri)
## Funding
USDA NRCS