Changes between Version 18 and Version 19 of GSoC/2021/JupyterAndGRASS

Timestamp:

Aug 20, 2021, 1:49:19 PM (3 years ago)

Author:

chaedri

Comment:

--

GSoC/2021/JupyterAndGRASS

@@ -1 +1 @@
 
-= GSoC 2021 Improved Integration of GRASS GIS and Jupyter Notebooks=
+= GSoC 2021: Improved Integration of GRASS GIS and Jupyter Notebooks=
 
 || Title: || '''Improved Integration of GRASS GIS and Jupyter Notebooks'' ||
@@ -6 +6 @@
 || Organization: || [http://www.osgeo.org OSGeo - Open Source Geospatial Foundation] ||
 || Mentor Name: || Vaclav Petras, Helena Mitasova, Stephan Blumentrath ||
-|| !GitHub Repository: || [https://github.com/chaedri/grass/  View Repo]  ||
+|| !GitHub Fork: || [https://github.com/chaedri/grass/tree/master/python/grass/jupyter  View Repo]  ||
 || GSoC proposal: || [https://docs.google.com/document/d/1ZT0cZobd87YCb3Ogis7RzWPj02XZkCpAHbC3VBGh7gc/edit?usp=sharing View Proposal]   ||
 
+[https://mybinder.org/v2/gh/OSGeo/grass/5e2fd30?urlpath=lab%2Ftree%2Fdoc%2Fnotebooks%2Fjupyter_integration.ipynb Try grass.jupyter in Binder here]
+
 == Abstract ==
-The current integration of GRASS GIS and Jupyter Notebooks requires a cumbersome environment variable setup after launching GRASS from within the notebook. It also only allows for simple, non-interactive map displays. My project will address both these issues and improve the GRASS-Jupyter integration with a new package called grass.jupyter.
+The previous integration of GRASS GIS and Jupyter Notebooks required a cumbersome environment variable setup after launching GRASS from within the notebook. It also only allowed for simple, non-interactive map displays. The `grass.jupyter` subpackage for addresses both these issues by introducing a new startup function, `init()`, and two display classes, `GrassRenderer` and `InteractiveMap`. `GrassRenderer` renders GRASS displays as PNG images. `InteractiveMap` displays rasters and vectors in [https://python-visualization.github.io/folium/index.html folium], a leaflet library for Python.
 
 == Goal ==
-My goal is to design a Python/PyGRASS library which will have 3 main components for improving the GRASS-Jupyter integration: 
-(1) creating new initiation functions for the launch of GRASS GIS in Jupyter Notebooks, 
-(2) creating functions for more intuitive map display and, 
-(3) introducing an interactive map display function.
+This project had three main objectives: 
+
+1. creating new initiation functions for the launch of GRASS GIS in Jupyter Notebooks (`init()`)
+
+2. creating functions for more intuitive map display (`GrassRenderer()`)
+
+3. introducing an interactive map display function (`InteractiveMap()`)
+
 
 == Timeline ==
@@ -195 +201 @@
 }}}
 {{{#!td
+Ok \\
+Ok \\
+Ok
 }}}
 
@@ -214 +223 @@
 No, I'm not currently blocked on anything.
 
-== Evaluation Status == 
-
-
-
 
 == Weekly reports ==
@@ -422 +427 @@
 Feedback, comments, questions and ideas welcome - especially for Future Work!
 
-
-== Future Work ==
-
-
-
-
-
-
+== Final Report ==
+**Title:** Improved Integration of Grass GIS and Jupyter Notebooks\\
+**Community:** GRASS GIS - OSGeo
+
+**Abstract:**\\
+ Check back later...
+
+**The state of integration BEFORE the start of GSoC:**\\
+Check back later...
+
+**The state of integration AFTER GSoC:**\\
+Check back later...
+
+**Conclusion:**\\
+Check back later...
+
+**Future Work:**\\
+* Height and width defaults in `GrassRenderer` should be derived from computational region
+* Add folium Tooltip method to `InteractiveMap`, allowing users to access vector attribute data by clicking on feature
+* Add simpleCRS option to `add_raster` method in `InteractiveMap`
+* Add option to display rasters as vectors (pixels -> polygon) in `InteractiveMap`
+* Clip vectors to computational region in `InteractiveMap` (currently the whole vector dataset is displayed)
+* Add more interactive functions: timeline slider for temporal datasets, etc.
+* `InteractiveMap` doesn't allow users to fully access folium. In the future, a new interface that allows users direct access to folium should be added. For example, it could look like: `gj.Raster("elevation").add_to(folium_map)`)
+
+
+**Permanent Links:**\\
+
+Pull requests related to `grass.jupyter`:\\
+|| '''Title''' || '''Pull Request'''||
+|| Added Binder setup files || https://github.com/OSGeo/grass/pull/1603 ||
+|| Binder Button || https://github.com/OSGeo/grass/pull/1628 ||
+|| Session Initiation functions for Jupyter Notebooks || https://github.com/OSGeo/grass/pull/1629 ||
+|| Added additional GRASS info to example_notebook || https://github.com/OSGeo/grass/pull/1686 ||
+|| Jupyter: Non-interactive display || https://github.com/OSGeo/grass/pull/1668 ||
+|| Interactive vector maps for Jupyter Notebooks || https://github.com/OSGeo/grass/pull/1710 ||
+|| __getattr__ shortcut for calling GRASS display modules || https://github.com/OSGeo/grass/pull/1723 ||
+|| Add temporary files for Non-Interactive Display || https://github.com/OSGeo/grass/pull/1727 ||
+|| Raster Support for Interactive Jupyter maps with folium || https://github.com/OSGeo/grass/pull/1769 ||
+|| Test Module for Non-interactive display in Jupyter Notebooks || https://github.com/OSGeo/grass/pull/1739 ||
+... two more PRs coming!
+
+
+OSGeo Wiki Page:\\
+https://trac.osgeo.org/grass/wiki/GSoC/2021/JupyterAndGRASS
+
+OSGeo-GRASS !github project page:\\ 
+https://github.com/OSGeo/grass/projects/7
+
+Github Fork and `grass.jupyter` directory:\\
+https://github.com/chaedri/grass/tree/master/python/grass/jupyter
+
+**Binder Examples:** \\
+[https://mybinder.org/v2/gh/OSGeo/grass/5e2fd30?urlpath=lab%2Ftree%2Fdoc%2Fnotebooks%2Fjupyter_integration.ipynb grass.jupyter tutorial]
+[more links coming...]
+
+
+