GRASS-Wiki - User contributions [en]

GRASS GSoC Ideas 2024

2024-09-15T08:08:04Z

29riyasaxena: /* Accepted ideas */

== About ==

* [https://wiki.osgeo.org/wiki/Google_Summer_of_Code_2024_Ideas The OSGeo GSoC 2024 main page]
* [https://summerofcode.withgoogle.com/ Official GSoC page at Google]

== Accepted ideas ==
=== Add JSON output to different GRASS tools in C ===
* Student: Kriti Birda
* Mentors: Corey White and Vaclav Petras
* [[GRASS_GSoC_2024_Add_JSON_output|Wiki page]]

=== Add EODAG support to GRASS GIS ===
* Student: Hamed Ashraf
* Mentors: Luca Delucchi, Veronica Andreo, Stefan Blumentrath
* [[GRASS_GSoC_2024_EODAG_Support|Wiki page]]

=== Parallelization of existing tools in GRASS GIS ===
* Student: Chung-Yuan Liang
* Mentors: Huidae Cho, Vaclav Petras, Maris Nartiss
* [[GRASS_GSoC_2024_Parallelize_Tools|Wiki page]]

=== Improve GRASS user experience in Jupyter Notebook ===
* Student: Riya
* Mentors: Anna Petrasova, Corey White
* [[GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks|Wiki page]]

== Ideas ==
If you are a student you can suggest a new idea or pick up an existing one. In any case write about it to [https://lists.osgeo.org/listinfo/grass-dev grass-dev mailing list],[https://github.com/OSGeo/grass/discussions GitHub Discussions], or [https://gitter.im/grassgis/community Gitter].

You are invited as well to have a close look at ideas from previous years ([https://trac.osgeo.org/grass/wiki/GSoC/2014 2014], [https://trac.osgeo.org/grass/wiki/GSoC/2015 2015], [https://trac.osgeo.org/grass/wiki/GSoC/2016 2016],
[https://trac.osgeo.org/grass/wiki/GSoC/2017 2017],
[https://trac.osgeo.org/grass/wiki/GSoC/2018 2018],
[https://trac.osgeo.org/grass/wiki/GSoC/2019 2019],
[https://trac.osgeo.org/grass/wiki/GSoC/2020 2020],
[https://trac.osgeo.org/grass/wiki/GSoC/2021 2021],
[https://trac.osgeo.org/grass/wiki/GSoC/2022 2022],
[https://trac.osgeo.org/grass/wiki/GSoC/2023 2023])
which have not yet been implemented.
You can also look at accepted GRASS GSoC [https://trac.osgeo.org/grass/wiki/GSoC projects from previous years] for an idea of scope.''

Include "GRASS GIS" in the title of our idea to easily distinguish ideas and projects inside OSGeo.

=== Parallelization of existing tools ===

There are several tools that would benefit from parallelization with OpenMP, e.g. r.texture, r.horizon, r.fill.stats, r/v.surf.idw, r.viewshed, v.to.rast, r.grow.distance, v.surf.bspline, ...
For overview of current state, see [[Raster_Parallelization_with_OpenMP]].

* Requirements: familiarity with C, OpenMP
* Mentor: Huidae Cho
* Co-mentor: Vaclav Petras, Anna Petrasova
* Project length: 175 or 350 hours (take your pick)
* Rating: medium
* Expected Outcomes: parallelized module or modules, depending on complexity
* Test of skills: suggest/implement solution for https://github.com/OSGeo/grass/issues/2644

=== Improve GRASS user experience in Jupyter Notebook ===
[[File:Jupyter_interactive_viewshed.png|500px|thumb|right|InteractiveMap in grass.jupyter library]]
Python package [https://grass.osgeo.org/grass-stable/manuals/libpython/grass.jupyter.html grass.jupyter] was developed during [https://trac.osgeo.org/grass/wiki/GSoC/2021/JupyterAndGRASS GSoC 2021] to simplify running GRASS from Jupyter Notebooks and displaying data. This project could focus on adding features such as adding parallelization for rendering, increasing interactivity of displayed data using ipyleaflet (e.g., capture mouse clicks to show information about vector line, pixel), adding API for managing projects and subprojects (i.e., locations/mapsets), simplifing display of attribute data, ...

* Requirements: Python
* Mentor: Anna Petrasova
* Co-mentor: Vaclav Petras, Helena Mitasova
* Project length: 175 or 350 hours (take your pick)
* Rating: easy to medium
* Expected Outcomes: improved user experience when using GRASS through notebooks
* Test of skills: https://github.com/OSGeo/grass/issues/3276, or write a test for [https://github.com/OSGeo/grass/tree/main/python/grass/jupyter grass.jupyter library] using python unittest or pytest, more info [https://grass.osgeo.org/grass-devel/manuals/libpython/gunittest_testing.html here].

=== Add JSON output to different tools in C ===
There are several tools in GRASS that would benefit from a JSON-formatted output, see [https://github.com/OSGeo/grass/issues/3020 this issue for a list of tools]. Besides adding the JSON output, the work would also include adding tests and basic documentation.
* Requirements: C, Python for tests
* Mentor: Vaclav Petras
* Co-mentor: Anna Petrasova, Corey White
* Project length: 175 or 350 hours (take your pick)
* Rating: easy to medium
* Expected Outcomes: one or more (depending on project length and complexity of the tool) tools with well tested JSON output
* Test of skills: Address https://github.com/OSGeo/grass/issues/1044 for r.surf.fractal

=== Support writing tests with pytest ===

* The current testing framework, ''[https://grass.osgeo.org/grass-stable/manuals/libpython/gunittest.html grass.gunittest]'', was written before migration to Git/GitHub and when long free runs in 3rd party services were unthinkable. Additionally, some no longer relevant goals were prioritized, such as independence on the current code, detailed custom HTML reports, success tracking over time, and high specialization towards GRASS-specifics.
* ''grass.gunittest'' is based on Python ''unittest'' package and many projects since then migrated to //pytest//, e.g., GDAL and Numpy. While ''unittest'' is inspired by Java's JUnit, ''pytest'' is designed to support writing small, readable tests, and uses plain `assert` statements instead of many different assert methods.
* Using ''pytest'' should lead to tests which feel more like Python scripts and to minimum of testing-specific code.
* An example issue of ''grass.gunittest'' is that it doesn't work well with tests of the main GRASS executable (prominence of `grass ... --exec` is yet another new thing which changed since ''grass.gunittest'' was designed).
* Two main things needed:
** Create general comparison functions from the ''grass.gunittest'' assert methods so that they can be used with pytest.
** Current grass.script.setup.init function and grass.script.core.create_location function don't work well in the context of a pytest test function. More
* Additional things needed:
** Fixture for pytest to set up and tear down a GRASS session in a temporary mapset.

* Requirements: Python
* Project length: 175 or 350 hours (take your pick)
* Mentor: Vaclav Petras
* Co-mentor: Stefan Blumentrath
* Proposed by: Vaclav Petras
* Rating: easy to medium
* Expected Outcomes: Convenient way of writing tests with pytest
* Test of skills: Fix failing tests and/or write new tests (more is better). Alternatively, addressing a smaller problem in the testing framework is a good task, too.

=== New easy-to-use CLI and API for GRASS GIS ===

* Make running of GRASS GIS modules as easy as it is to run GDAL commands.
** `grass run r.slope.aspect elevation=elevation.tiff slope=slope.tiff aspect=aspect.tiff`
** CLI like GDAL has.
** No GRASS Database, Location, Mapset to deal with.
** No import, export from user perspective.
** Reasonable defaults for things like region.
** CLI and API still allows user to specify any of the above.
* Idea page with details: wiki:GSoC/2021/EasyToUseCliAndApiIdea
* Project length: 350 hours
* Rating: medium
* Requirements:
** Language: Python
** Proposal: Student needs to show sufficient understanding of the GRASS GIS Database structure and significantly extend on text below in terms of more concrete formulation of ideas and identification of missing and existing parts.
* Mentors: Vaclav Petras
* Co-mentors: Stefan Blumentrath
* Proposed by: Vaclav Petras
* Expected outcomes: New subcommand which easily runs a GRASS module on GeoTiff and GeoPackage.
* Test and training tasks:
** Solve one of the tickets linked at the idea page.
** Add features to `grass` executable interface:
*** Make it possible to associate `*.gxw` files with `grass` executable (#1204) or at least add `--gui-workspace` or preferably just recognize it in the command line (distinguish it from database/location/mapset).
** Extend `--exec` functionality:
*** Add `--region` to set a temporary computational region for the execution, e.g. `--region="raster=raster_name"`
*** Add `--import-raster=some/file.tiff` which imports (r.import) a raster file (same for vector and similarly for export).
*** Add `--link-raster=some/file.tiff` which links (r.external) a raster file (same for vector and similarly for r.external.out).

=== STAC (SpatioTemporal Asset Catalog) Integration ===

Create new import and export capabilities for GRASS GIS which allow users to easily ingest data from STAC catalogs and export locations and mapsets as STAC specs for data discovery within STAC browsers.

* Requirements: familiar with python, STAC specs
* Mentor: Corey White
* Co-mentor: Vaclav Petras, Anna Petrasova
* Project length: 175 or 350 hours (take your pick)
* Rating: medium
* Expected Outcomes: completion of t.in.stac and t.out.stac
* Test of skills:
** suggest or implement solution for implementing t.out.stac using the prototype STAC spec https://github.com/tomorrownow/grass-stac-extension
** suggest/implement solution for completing https://github.com/OSGeo/grass-addons/pull/802

=== Add EODAG support to GRASS GIS ===

[https://eodag.readthedocs.io/en/stable/ EODAG] is a Python library useful to download several satellite datasets from different providers (i.e., USGS, Copernicus, AWS, Planetary Computer, etc.). GRASS has various modules to download satellite data like i.sentinel.download, i.landsat.download, i.modis.download. However, they all use different libraries, some of them no longer maintained. Hence, implementing the use of EODAG as back-end for those tools would be very useful not only in terms of maintenance but also in terms of less code repetition. It would also open the possibility for new tools or a master tool to download other datasets directly from GRASS.

* Requirements: familiar with Python
* Project length: 175 or 350 hours
* Mentor: Luca Delucchi
* Co-mentor: Veronica Andreo
* Proposed by: Luca Delucchi
* Rating: medium
* Expected Outcomes: 175 hours EODAG core library to be able to download products; 350 library + application at least to i.sentinel.download but hopefully also to i.landsat.download
* Test of skills: https://github.com/OSGeo/grass-addons/issues/1033

=== GUI: Add space-time datasets support in Data Catalog ===
[[File:GUI_data_tab.png|400px|thumb|right|Data catalog]]
Currently GRASS Data Catalog shows only raster and vector maps. The goal of this project is to add support for space-time datasets. It is mainly space-time raster datasets. In the next phase of the project support for other types of space-time datasets (vector and 3D raster) could be added. Besides displaying space-time datasets in the layer tree, it is also about adding the equivalent functionality currently available for raster and vector layers from the context menu.

* Requirements: familiar with Python
* Project length: 175 or 350 hours
* Mentor: Martin Landa
* Co-mentor: Anna Petrasova
* Proposed by: Martin Landa
* Rating: medium
* Expected Outcomes: 175 hours basic support for space-time raster datasets; 350 extended support also for other space-time datasets types (vector, 3D raster)
* Test of skills:
** suggest/implement solution for completing https://github.com/OSGeo/grass/issues/2599

=== Add {your research idea} to GRASS GIS ===

* In general, you can propose any topic, but you can specifically propose integrating your research or research idea into GRASS GIS.
* Requirements:
** Language:
*** Depends on the project, often Python, sometimes C.
*** Adding your latest ecological analysis
** Proposal:
*** Discuss relevance to GRASS GIS.
*** Describe technical steps needed for integration.
*** Describe whether it is an addition of a tool (module) or a change in one of the libraries. If it is a tool, specify if it should be included in the core grass repository or in grass-addons repository and why.
*** Specify what research was done and what needs to be accomplished in order to have usable product at the end of summer.
*** Specify who will provide the research expertise.
* Project length: 175 or 350 hours (take your pick)
* Rating: from low to hard
* Mentors:
** GRASS GIS project will provide technical mentors, but it is up to the applicant to ensure the research part is mentored well. An exception may be granted to applicants which can demonstrate that the research is finished or that they have enough expertise themselves.
** Possible technical mentors: Vaclav Petras, Anna Petrasova
** Research mentors: Bring in an expert from your field, e.g., your academic advisor or project principal investigator (if needed).
* Proposed by: Vaclav Petras
* Expected outcome: Working feature which is integrated and merged at the end of the project.
* Test and training tasks:
** Create a test in Python for an existing tool in the grass-addons repository or in the core grass repository.

=== Title of idea ===

Description here

* Requirements:
* Project length: (175 or 350 hours)
* Mentor:
* Proposed by:
* Rating:
* Expected Outcomes:
* Test of skills:
* Other:

== Tips for students ==

* If you have your own ideas we encourage you to propose them. Explain them on the [https://lists.osgeo.org/listinfo/grass-dev grass-dev mailing list].
* If you like some idea here or from previous yeas, write about it on [https://lists.osgeo.org/listinfo/grass-dev grass-dev mailing list] and any ideas of your own which could improve it.
* Follow some good practices in your ideas and proposals:
** Stress why the project would be useful.
** Show that you know how you will proceed. That is, make sure that you can demonstrate that the proposal is feasible in the given time frame.
** Be specific in the implementation (or at least as specific as you can).
** Explain what the final product will look like and how it will work. You can add drawings or mock-ups.
** Explain how the idea relates to existing GRASS GIS functions, features, and needs.
** Do not include steps such as "install GRASS", "compile GRASS libraries (on my machine)", "read about the API". You should do this before applying to GSoC.
* Compile GRASS GIS from source and prepare environment for development:
** Read [https://github.com/OSGeo/grass/blob/main/CONTRIBUTING.md CONTRIBUTING file] and [https://grasswiki.osgeo.org/wiki/Compile_and_Install compilation instructions].
** If you get stuck with the setup, feel free to consult the [https://lists.osgeo.org/listinfo/grass-user grass-user mailing list].
** Familiarize yourself with wiki:Submitting rules.
* Prove your worth by being active on the GRASS mailing lists ([https://lists.osgeo.org/listinfo/grass-user grass-user], [https://lists.osgeo.org/listinfo/grass-dev grass-dev]) or other channels ([https://github.com/OSGeo/grass/discussions GitHub Discussions], [https://gitter.im/grassgis/community Gitter]), fix some [https://github.com/OSGeo/grass/issues bugs], and/or implement some (smaller) features, or write some (simpler) GRASS module, and post it to mailing list. There's no better way to demonstrate your willingness and abilities. Do this before start you apply to GSoC.
* Also note that fixing existing bugs and/or implementing enhancements will be a part of student evaluation.

* Every year GRASS GIS hopes to participate and participates in GSoC as part of the [https://www.osgeo.org/ OSGeo Foundation]'s GSoC program umbrella. See the official OSGeo template for application details and other important information at the [https://wiki.osgeo.org/wiki/Google_Summer_of_Code_Recommendations_for_Students OSGeo Recommendations for Students].

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-25T06:58:00Z

29riyasaxena: /* Links */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || In Progress
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary || OK
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation || OK
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''
# '''Started working on custom projections in <code>InteractiveMap</code>[https://github.com/OSGeo/grass/pull/4204 (PR)]'''

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Organization''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.
# Enhanced connectivity with Pandas will enable users to display data with a single command.
# Large, high-resolution image display will be enabled by implementing tiling techniques, reducing memory consumption and enabling smooth rendering of large images.
# Implementing a graphical user interface (GUI) for tool presentation within Jupyter Notebooks would simplify usability and enhance user experience, facilitating smoother workflows within the platform.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
! Status
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
| <span style="color:#8256d0">Merged</span>
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
| <span style="color:#8256d0">Merged</span>
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
| <span style="color:#8256d0">Merged</span>
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
| <span style="color:#8256d0">Merged</span>
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
| <span style="color:#8256d0">Merged</span>
|-
|-
| Use <code>InteractiveMap</code> with custom projections
| [https://github.com/OSGeo/grass/pull/4204 4204]
| <span style="color:#008000">Open</span>
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
| <span style="color:#8256d0">Merged</span>
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
| <span style="color:#8256d0">Merged</span>
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-25T06:52:40Z

29riyasaxena: /* Timeline */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || In Progress
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary || OK
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation || OK
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''
# '''Started working on custom projections in <code>InteractiveMap</code>[https://github.com/OSGeo/grass/pull/4204 (PR)]'''

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Organization''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.
# Enhanced connectivity with Pandas will enable users to display data with a single command.
# Large, high-resolution image display will be enabled by implementing tiling techniques, reducing memory consumption and enabling smooth rendering of large images.
# Implementing a graphical user interface (GUI) for tool presentation within Jupyter Notebooks would simplify usability and enhance user experience, facilitating smoother workflows within the platform.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
|-
| Use <code>InteractiveMap</code> with custom projections
| [https://github.com/OSGeo/grass/pull/4204 4204]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-25T06:11:25Z

29riyasaxena: /* Final Report */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Ongoing
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''
# '''Started working on custom projections in <code>InteractiveMap</code>[https://github.com/OSGeo/grass/pull/4204 (PR)]'''

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Organization''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.
# Enhanced connectivity with Pandas will enable users to display data with a single command.
# Large, high-resolution image display will be enabled by implementing tiling techniques, reducing memory consumption and enabling smooth rendering of large images.
# Implementing a graphical user interface (GUI) for tool presentation within Jupyter Notebooks would simplify usability and enhance user experience, facilitating smoother workflows within the platform.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
|-
| Use <code>InteractiveMap</code> with custom projections
| [https://github.com/OSGeo/grass/pull/4204 4204]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-24T17:12:59Z

29riyasaxena: /* Links */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Ongoing
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''
# '''Started working on custom projections in <code>InteractiveMap</code>[https://github.com/OSGeo/grass/pull/4204 (PR)]'''

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.
# Enhanced connectivity with Pandas will enable users to display data with a single command.
# Large, high-resolution image display will be enabled by implementing tiling techniques, reducing memory consumption and enabling smooth rendering of large images.
# Implementing a graphical user interface (GUI) for tool presentation within Jupyter Notebooks would simplify usability and enhance user experience, facilitating smoother workflows within the platform.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
|-
| Use <code>InteractiveMap</code> with custom projections
| [https://github.com/OSGeo/grass/pull/4204 4204]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-24T16:55:32Z

29riyasaxena: /* Future Work */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Ongoing
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''
# '''Started working on custom projections in <code>InteractiveMap</code>[https://github.com/OSGeo/grass/pull/4204 (PR)]'''

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.
# Enhanced connectivity with Pandas will enable users to display data with a single command.
# Large, high-resolution image display will be enabled by implementing tiling techniques, reducing memory consumption and enabling smooth rendering of large images.
# Implementing a graphical user interface (GUI) for tool presentation within Jupyter Notebooks would simplify usability and enhance user experience, facilitating smoother workflows within the platform.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-24T16:52:49Z

29riyasaxena: /* Timeline */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Ongoing
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''
# '''Started working on custom projections in <code>InteractiveMap</code>[https://github.com/OSGeo/grass/pull/4204 (PR)]'''

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-24T16:49:29Z

29riyasaxena: /* Week-12 */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''
# '''Started working on custom projections in <code>InteractiveMap</code>[https://github.com/OSGeo/grass/pull/4204 (PR)]'''

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-24T16:21:14Z

29riyasaxena: /* Week-12 */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# '''Wrote Report'''.
# '''Started working on [https://github.com/OSGeo/grass/pull/4204 custom projections in <code>InteractiveMap</code>]'''.

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-24T16:18:04Z

29riyasaxena: /* Week-12 */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==
# Wrote Report.
# Started working on custom projections in <code>InteractiveMap</code>.

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-19T13:34:23Z

29riyasaxena: /* Working of grass.jupyter.InteractiveMap() */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Images ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

== Media ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-19T13:27:54Z

29riyasaxena: /* Final Report */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

=== Links ===

Pull requests related to <code>grass.jupyter</code>:
{| class="wikitable"
! Ttile
! Pull Request
|-
| Create BaseSeriesMap to remove redundancies in SeriesMap and TimeSeriesMap
| [https://github.com/OSGeo/grass/pull/3468 3468]
|-
| Add Query Button to InteractiveMap
| [https://github.com/OSGeo/grass/pull/3793 3793]
|-
| Allow Users to view/update computational region
| [https://github.com/OSGeo/grass/pull/3838 3838]
|-
| Allow users to draw simple geometries and save it as vector
| [https://github.com/OSGeo/grass/pull/4003 4003]
|-
| Add Parallelization to TimeSeriesMap and SeriesMap
| [https://github.com/OSGeo/grass/pull/4097 4097]
|-
| Add documentation of InteractiveMap Features and Parallelization in jupyter_tutorial.ipynb
| [https://github.com/OSGeo/grass/pull/4164 4164]
|-
| Modify Descriptions
| [https://github.com/OSGeo/grass/pull/4159 4159]
|}

Some additional links:
{| class="wikitable"
! Ttile
! Link
|-
| OSGeo Wiki Page
| [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Improve User Experience in Jupyter Notebooks]
|-
| Github Fork
| [https://github.com/29riyasaxena/grass/tree/main GitHub Fork]
|-
| Example
| [https://github.com/29riyasaxena/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb <code>jupyter_tutorial</code>]
|}

== Working of grass.jupyter.InteractiveMap() ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-19T06:30:24Z

29riyasaxena: /* Future Work */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

=== Future Work ===
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

== Working of grass.jupyter.InteractiveMap() ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-19T06:30:04Z

29riyasaxena: /* Conclusion */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

=== Conclusion ===

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

== Future Work ==
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

== Working of grass.jupyter.InteractiveMap() ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-19T06:28:30Z

29riyasaxena: /* Future Work */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Conclusion ==

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

== Future Work ==
# [https://github.com/OSGeo/grass/pull/3793#discussion_r1644111142 Improve the distance used in Query Button functionality].
# Use [https://ipyleaflet.readthedocs.io/en/latest/controls/geoman_draw_control.html <code>GeomanDrawControl</code>] in the Draw Button functionality.

== Working of grass.jupyter.InteractiveMap() ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-19T06:16:14Z

29riyasaxena: /* Working of grass.jupyter.InteractiveMap() */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Conclusion ==

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

== Future Work ==

== Working of grass.jupyter.InteractiveMap() ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass geometries.png|thumb|alt=Picture showing the various draw controls of the Draw Button|Shows the various draw controls of the Draw Button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass gif draw.gif|thumb|alt=GIF showing the working of the Draw Button|Working of the Draw Button]]
| [[File:Grass gif query.gif|thumb|alt=GIF showing the working of the Query Button|Working of the Query Button]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

File:Grass geometries.png

2024-08-19T05:59:50Z

29riyasaxena:

Picture showing the various draw controls of the Draw Button

File:Grass gif draw.gif

2024-08-19T05:58:17Z

29riyasaxena:

GIF showing the working of the Draw Button

File:Grass gif query.gif

2024-08-19T05:55:16Z

29riyasaxena:

GIF showing the working of the Query Button

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-16T11:37:51Z

29riyasaxena: /* Working of grass.jupyter.InteractiveMap() */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Conclusion ==

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

== Future Work ==

== Working of grass.jupyter.InteractiveMap() ==

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass draw and query.png|thumb|width=385px|height=300px|alt=Draw and Query Functioning|Draw and Query]]
| [[File:Grass update region before.png|thumb|width=385px|height=300px|alt=Shows the original computational region|Original Computational Region]]
| [[File:Grass_update_region_after.png|thumb|width=385px|height=300px|alt=Shows the modified computational region|Modified Computational Region]]
|}

{| style="width: 100%; text-align: center;"
|-
| [[File:Grass update region gif.gif|thumb|alt=GIF showing the function of update region button|GIF showing the function of update region button]]
| [[File:Grass seriesmap.png|thumb|alt=Displays benchmark on SeriesMap|Benchmark on SeriesMap]]
| [[File:Grass timeseriesmap.png|thumb|alt=Displays benchmark on TimeSeriesMap|Benchmark on TimeSeriesMap]]
|}

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

{{GSoC}}

File:Grass timeseriesmap.png

2024-08-16T11:26:34Z

29riyasaxena:

Displays benchmark on TimeSeriesMap

File:Grass seriesmap.png

2024-08-16T11:24:09Z

29riyasaxena:

Displays benchmark on SeriesMap

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-15T18:13:49Z

29riyasaxena: /* Final Report */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Conclusion ==

This project has successfully improved the user experience of <code>GRASS GIS</code> in <code>Jupyter Notebook</code>. Significant enhancements have been made to the <code>InteractiveMap</code>, <code>SeriesMap</code>, and <code>TimeSeriesMap</code>. The new features, such as the ''Query Button'', ''View/Update Computational Region Button'', and ''Draw Geometries Button'', have streamlined data querying, visualization, and editing processes. Introducing the <code>BaseSeriesMap</code> has reduced redundancy, and parallelization has substantially improved performance. Benchmark results show notable speed improvements, making <code>GRASS GIS</code> more efficient and user-friendly. These advancements contribute to a more seamless and productive experience for users.

I appreciate the support and opportunity to contribute to GRASS GIS this summer. Thanks to my mentors and the GRASS Development Team for their guidance. Anna Petrasova's contributions were pivotal to the project's success, and I'm grateful for her support. Looking forward to contributing more.

== Future Work ==

== Working of grass.jupyter.InteractiveMap() ==

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

<gallery widths="385px" heights="300px" perrow="3">
File:Grass draw and query.png|alt=Draw and Query Functioning|Draw and Query
File:Grass update region before.png|alt=Shows the original computational region|Original Computational Region
File:Grass_update_region_after.png|alt=Shows the modified computational region|Modified Computational Region
</gallery>

[[File:Grass update region gif.gif|thumb|text-align:center|alt=GIF showing the function of update region button|GIF showing the function of update region button]]

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-15T17:24:43Z

29riyasaxena: /* Working of grass.jupyter.InteractiveMap() */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Working of grass.jupyter.InteractiveMap() ==

{| style="width:100%;"
| style="width:30%; vertical-align:top;" | [[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
| style="width:30%; text-align:center; vertical-align:top;" | [[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
| style="width:30%; vertical-align:top;" | [[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
|}

<gallery widths="385px" heights="300px" perrow="3">
File:Grass draw and query.png|alt=Draw and Query Functioning|Draw and Query
File:Grass update region before.png|alt=Shows the original computational region|Original Computational Region
File:Grass_update_region_after.png|alt=Shows the modified computational region|Modified Computational Region
</gallery>

[[File:Grass update region gif.gif|thumb|text-align:center|alt=GIF showing the function of update region button|GIF showing the function of update region button]]

{{GSoC}}

File:Grass update region after.png

2024-08-15T16:59:16Z

29riyasaxena:

Shows the updated computational region

File:Grass update region before.png

2024-08-15T16:57:12Z

29riyasaxena:

Shows the original computational region

File:Grass update region gif.gif

2024-08-15T16:27:35Z

29riyasaxena:

A GIF showing the working of update region function.

File:Grass draw and query.png

2024-08-15T16:07:01Z

29riyasaxena:

It displays the results of querying on a drawn vector.

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T08:02:48Z

29riyasaxena: /* Timeline */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1 - May 26
||
# Initial research
# Proposal discussion with mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
|| OK
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' || OK
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button || OK
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' || OK
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings || OK
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants || OK
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection || Postponed
|-
| style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
|| OK
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' || OK
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial || OK
|-
| '''Week 10''' (July 28 - August 3) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 11''' (August 4 - August 10) || <s>Working on a selected stretch goal</s> Worked on Handling Toggle Buttons || OK
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Working of grass.jupyter.InteractiveMap() ==

<div style="float:left; width:30%;">
[[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
</div>

<div style="float:left; width:30%; text-align:center;">
[[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
</div>

<div style="float:left; width:30%;">
[[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
</div>

<div style="clear:both;"></div>

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T07:59:25Z

29riyasaxena: /* Final Report */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1- May 26
||
# Initial research
# Proposal Discussion with Mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
||
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' ||
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button ||
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' ||
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings ||
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants ||
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection ||
|-
|style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
||
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' ||
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial ||
|-
| '''Week 10''' (July 28 - August 3) || Working on a selected stretch goal ||
|-
| '''Week 11''' (August 4 - August 10) || Working on a selected stretch goal
||
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>. Below is an example of how to reproduce this benchmark:

<syntaxhighlight lang="python">
cores_range = range(1, 13)
benchmark_results = {}
for cores in cores_range:
gs.run_command("g.gisenv", set=f"NPROCS={cores}")
start_time = time.time()
series = gj.SeriesMap(height=500)
series.add_rasters(["elevation", "elevation_shade", "slope"])
series.add_vectors(["streams", "streets", "viewpoints"])
series.d_vect(map="streets")
series.d_barscale()
series.show() # Create Slider
end_time = time.time()
elapsed_time = end_time - start_time
benchmark_results[cores] = elapsed_time
print(f"Cores: {cores}, Time: {elapsed_time:.2f} seconds")
</syntaxhighlight>

<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Working of grass.jupyter.InteractiveMap() ==

<div style="float:left; width:30%;">
[[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
</div>

<div style="float:left; width:30%; text-align:center;">
[[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
</div>

<div style="float:left; width:30%;">
[[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
</div>

<div style="clear:both;"></div>

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T07:51:04Z

29riyasaxena: /* Working */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1- May 26
||
# Initial research
# Proposal Discussion with Mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
||
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' ||
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button ||
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' ||
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings ||
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants ||
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection ||
|-
|style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
||
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' ||
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial ||
|-
| '''Week 10''' (July 28 - August 3) || Working on a selected stretch goal ||
|-
| '''Week 11''' (August 4 - August 10) || Working on a selected stretch goal
||
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap:</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>.
<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Working of grass.jupyter.InteractiveMap() ==

<div style="float:left; width:30%;">
[[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
</div>

<div style="float:left; width:30%; text-align:center;">
[[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
</div>

<div style="float:left; width:30%;">
[[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
</div>

<div style="clear:both;"></div>

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T07:42:00Z

29riyasaxena: /* Working */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1- May 26
||
# Initial research
# Proposal Discussion with Mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
||
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' ||
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button ||
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' ||
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings ||
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants ||
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection ||
|-
|style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
||
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' ||
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial ||
|-
| '''Week 10''' (July 28 - August 3) || Working on a selected stretch goal ||
|-
| '''Week 11''' (August 4 - August 10) || Working on a selected stretch goal
||
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap:</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>.
<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Working ==

<div style="float:left; width:30%;">
[[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
</div>

<div style="float:left; width:30%; text-align:center;">
[[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
</div>

<div style="float:left; width:30%;">
[[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]
</div>

<div style="clear:both;"></div>

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T07:34:08Z

29riyasaxena: /* Working */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1- May 26
||
# Initial research
# Proposal Discussion with Mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
||
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' ||
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button ||
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' ||
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings ||
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants ||
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection ||
|-
|style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
||
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' ||
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial ||
|-
| '''Week 10''' (July 28 - August 3) || Working on a selected stretch goal ||
|-
| '''Week 11''' (August 4 - August 10) || Working on a selected stretch goal
||
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap:</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>.
<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Working ==
<div style="float:left;">
[[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
</div>
[[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
[[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T07:16:03Z

29riyasaxena: /* Working */

{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1- May 26
||
# Initial research
# Proposal Discussion with Mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
||
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' ||
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button ||
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' ||
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings ||
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants ||
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection ||
|-
|style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
||
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' ||
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial ||
|-
| '''Week 10''' (July 28 - August 3) || Working on a selected stretch goal ||
|-
| '''Week 11''' (August 4 - August 10) || Working on a selected stretch goal
||
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

= Reports =

== Bonding Period ==
# '''Contribution Guidelines''': Spent time familiarizing myself with the project's contribution guidelines to ensure that my work aligns with the required standards.
# '''Introduction''': [https://discourse.osgeo.org/t/gsoc-2024-introduction-riya-saxena/28245 Introduced myself to the discourse mailing list].
# '''WikiPages Setup''': Created and organized [https://wiki.osgeo.org/wiki/User:29riyasaxena my personal WikiPage] and the [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks| project WikiPage], providing necessary documentation.
# '''Development Environment Configuration''': Successfully set up and configured the development environment to streamline my coding and testing processes.
# '''GRASS GIS Exploration''': Learnt more about GRASS GIS.
# '''Remove Redundancy in the code''': Continued working on the [https://github.com/OSGeo/grass/pull/3468 pull request] to remove redundancies in the <code>SeriesMap</code> and <code>TimeSeriesMap</code> modules opened by me before the Contributor Proposals Opened.

== Week-1 ==
# '''Created the Class <code>BaseSeriesMap</code> [https://github.com/OSGeo/grass/pull/3468 (PR)]'''
#:* The <code>BaseSeriesMap</code> class serves as a base class for <code>SeriesMap</code> and <code>TimeSeriesMap</code>.
#:* It eliminates code redundancy and offers a unified interface for rendering images and creating interactive timeline sliders.
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enabled users to retrieve the Latitude and Longitude of raster data upon activation of Query Button.

== Week-2 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added functionality to handle both raster and vector data.
#:* The button now returns output to the user in the Coordinate Reference System (CRS).

== Week-3 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added a Popup button to display the queried point.
#:* Enabled support for multiple raster and vector layers.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Began initial work on this feature, for example, adding the button, getting the region, etc.

== Week-4 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Explored methods to dynamically calculate the query threshold distance.
#:* Made slight modifications to the display of the Query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Attempted to use <code>ipyleaflet.Rectangle</code> as an alternative to <code>DrawControl</code>, but this method was unsuccessful.

== Week-5 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Added test case for query button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added a rectangle to display the current computational region when this button is activated.
#:* User can modify the current computational region by adjusting the rectangle.

== Week-6 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Enhanced the appearance of the popup button that will display the output.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Worked on enhancing the display of the computational region.

== Week-7 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Finalized the appearance of the popup button.
# '''View/Update Computational Region Button [https://github.com/OSGeo/grass/pull/3838 (PR)]'''
#:* Added functionality for zooming into the computational region.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Users can now draw simple geometries in <code>InteractiveMap</code> and save them as GRASS native vector maps.
#:* Transitioned from <code>DrawControl</code> (deprecated) to <code>GeomanDrawControl</code> in <code>ipyleaflet</code>.

== Week-8 ==
# '''Query Button [https://github.com/OSGeo/grass/pull/3793 (PR)]'''
#:* Worked on pylint errors.
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Discovered limitations of <code>GeomanDrawControl</code> and reverted to <code>DrawControl</code>.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Began working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-9 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Updated the display of buttons.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Continued working on parallelization for <code>TimeseriesMap</code> and <code>SeriesMap</code>.

== Week-10 ==
# '''Drawing and Saving of Simple Geometries [https://github.com/OSGeo/grass/pull/4003 (PR)]'''
#:* Did some final edits in the code.
# '''Parallelization [https://github.com/OSGeo/grass/pull/4097 (PR)]'''
#:* Added parallelization in the render function for <code>TimeseriesMap</code> and <code>SeriesMap</code>, and completed this task.

== Week-11 ==
# '''Managing Multiple Toggle Buttons'''
#:* Implemented <code>[https://github.com/OSGeo/grass/pull/4003 InteractiveDrawController]</code> and [https://github.com/OSGeo/grass/pull/3793 <code>InteractiveQueryController</code>] to handle individual events.
# '''[https://github.com/OSGeo/grass/pull/4164 Modified Tutorials]'''
# '''[https://github.com/OSGeo/grass/pull/4159 Updated Descriptions]'''

== Week-12 ==

= Final Report =
'''Title''': Improve GRASS user experience in Jupyter Notebook

'''Community''': GRASS GIS - OSGeo

=== Abstract ===

This project introduces three significant enhancements to the <code>InteractiveMap</code>: a ''Query Button'' for querying specific points, a ''View/Update Computational Region Button'' for directly viewing and updating the computational region, and a ''Draw Geometries Button'' for creating and adding simple geometries as GRASS native vector maps. Additionally, the project introduces the <code>BaseSeriesMap</code> to reduce redundancy between <code>SeriesMap</code> and <code>TimeSeriesMap</code>, and adds parallelization to both <code>SeriesMap</code> and <code>TimeSeriesMap</code> for improved performance.

=== The state of integration BEFORE the start of GSoC ===

Previously, it was not possible to query vector/raster data, draw geometries, or view the computational region in <code>InteractiveMap</code>. While updating the region was possible, it required running additional commands. Additionally, improving the rendering speed of images in <code>SeriesMap</code> and <code>TimeSeriesMap</code> was not feasible.

=== The state of integration AFTER GSoC ===

# '''Features in <code>grass.InteractiveMap()</code>''': The <code>grass.jupyter.interactivemap.py</code> module includes three key features: the Query button (ℹ️), the View/Update Computational Region button (◻️), and the Draw Geometries button (🖉).
## '''Querying Raster/Vector Information at a Specific Point''' (ℹ️)
### ''Activate the Query Tool'': Click the '''info''' button (ℹ️) to enable the query mode.
### ''Select a Point on the Map'': Click on the map to retrieve raster/vector information for that specific point.
### ''Deactivate the Tool'': Toggle the button off when you're done.
## '''Drawing and Saving Geometries as GRASS Native Vector Maps''' (🖉)
### ''Activate the Drawing Tool'': Click the '''Pencil''' button (🖉) to start drawing on the map.
### ''Draw Your Geometry'': You can draw a polyline, polygon, or circle marker directly on the map.
### ''Name the Vector Map'': Enter the name for the new vector map in the '''New vector map name''' text box.
### ''Save the Geometry'': Click the '''Save''' button to add the geometry to the map.
### ''Finalize and Close'': The geometry is now added as a new layer on the map, and the drawing interface will automatically close.
## '''Viewing and Updating the Computational Region''' (◻️)
### ''Activate the Computational Region Tool'': Click the '''View/Update Computational Region''' button (◻️).
### ''Visualize the Current Region'': The current computational region is displayed as a rectangle on the map.
### ''Adjust the Region'': Move the rectangle to a new location or resize it by dragging its vertices.
### ''Update the Region'': Click '''Update Region''' to apply your changes to the computational region.
### ''Deactivate the Tool'': Toggle the button off when you're done.
# '''Removal of redundancy in the <code>TimeSeriesMap</code> and <code>SeriesMap</code>''': A new class, <code>BaseSeriesMap</code>, has been added to serve as a parent class to both <code>TimeSeriesMap</code> and <code>SeriesMap</code>. This enhancement reduces redundancy and streamlines the codebase.
# '''Parallelization in <code>SeriesMap</code> and <code>TimeSeriesMap:</code>'''
#:*'''Benchmark for <code>TimeSeriesMap</code> and <code>SeriesMap</code>:''' The following tables present the performance results obtained using 1-12 cores, as tested on the examples in <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/temporal.ipynb temporal.ipynb]</code> and <code>[https://github.com/OSGeo/grass/blob/main/doc/notebooks/jupyter_tutorial.ipynb jupyter_tutorial.ipynb]</code>.
<center>
<table class="wikitable">
<caption>Performance Results - TimeSeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>53.42</td>
<td>26.24</td>
<td>18.99</td>
<td>18.50</td>
<td>15.08</td>
<td>14.04</td>
<td>17.68</td>
<td>15.75</td>
<td>16.00</td>
<td>14.12</td>
<td>14.22</td>
<td>14.76</td>
</tr>
</table>

<table class="wikitable">
<caption>Performance Results - SeriesMap</caption>
<tr>
<th>Cores</th>
<th>1</th>
<th>2</th>
<th>3</th>
<th>4</th>
<th>5</th>
<th>6</th>
<th>7</th>
<th>8</th>
<th>9</th>
<th>10</th>
<th>11</th>
<th>12</th>
</tr>
<tr>
<td>Time (sec)</td>
<td>4.88</td>
<td>2.47</td>
<td>1.58</td>
<td>1.67</td>
<td>1.74</td>
<td>1.73</td>
<td>1.68</td>
<td>1.64</td>
<td>1.65</td>
<td>1.64</td>
<td>1.62</td>
<td>1.61</td>
</tr>
</table>
</center>

== Working ==
[[File:Grass draw geometries.mp4|thumb|alt=Working of Draw Geometries Button|Working of Draw Geometries Button]]
[[File:Grass query.mp4|thumb|alt=Working of Query Button|Working of Query Button]]
[[File:Grass view update region.mp4|thumb|alt=View/Update Region Button Working|Working of View/Update Region Button]]

{{GSoC}}

File:Grass view update region.mp4

2024-08-14T07:12:54Z

29riyasaxena:

Working of view/update region button

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T07:05:28Z

29riyasaxena: /* The state of integration AFTER GSoC */

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T06:25:23Z

29riyasaxena: /* The state of integration AFTER GSoC */

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-14T06:09:49Z

29riyasaxena: /* The state of integration AFTER GSoC */

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-13T17:31:24Z

29riyasaxena: /* The state of integration AFTER GSoC */

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-13T17:30:01Z

29riyasaxena: /* Final Report */

File:Grass update region.mp4

2024-08-13T17:05:52Z

29riyasaxena:

Working of Update Region Button

File:Grass draw geometries.mp4

2024-08-13T17:04:18Z

29riyasaxena:

Working of Draw Geometries Button

File:Grass query.mp4

2024-08-13T17:02:41Z

29riyasaxena:

Working of Query button

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-08-13T15:01:16Z

29riyasaxena: /* Reports */

GRASS GSoC Ideas 2024

2024-05-11T10:26:23Z

29riyasaxena:

== About ==

* [https://wiki.osgeo.org/wiki/Google_Summer_of_Code_2024_Ideas The OSGeo GSoC 2024 main page]
* [https://summerofcode.withgoogle.com/ Official GSoC page at Google]

== Accepted ideas ==
=== Add JSON output to different GRASS tools in C ===
* Student: Kriti Birda
* Mentors: Corey White and Vaclav Petras
* [[GrassJsonGsoc2024|Wiki page]]

=== Add EODAG support to GRASS GIS ===
* Student: Hamed Ashraf
* Mentors: Luca Delucchi, Veronica Andreo, Stefan Blumentrath
* [https://wiki.osgeo.org/wiki/GRASS_GSoC_2024_EODAG_Support Wiki page]

=== Parallelization of existing tools in GRASS GIS ===
* Student: Chung-Yuan Liang
* Mentors: Huidae Cho, Vaclav Petras, Maris Nartiss
* [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Parallelize_Tools Wiki page]

=== Improve GRASS user experience in Jupyter Notebook ===
* Student: Riya Saxena
* Mentors: Anna Petrasova, Corey White
* [https://grasswiki.osgeo.org/wiki/GRASS_GSoC_2024_Improve_user_experience_in_Jupyter_Notebooks Wiki page]

== Ideas ==
If you are a student you can suggest a new idea or pick up an existing one. In any case write about it to [https://lists.osgeo.org/listinfo/grass-dev grass-dev mailing list],[https://github.com/OSGeo/grass/discussions GitHub Discussions], or [https://gitter.im/grassgis/community Gitter].

You are invited as well to have a close look at ideas from previous years ([https://trac.osgeo.org/grass/wiki/GSoC/2014 2014], [https://trac.osgeo.org/grass/wiki/GSoC/2015 2015], [https://trac.osgeo.org/grass/wiki/GSoC/2016 2016],
[https://trac.osgeo.org/grass/wiki/GSoC/2017 2017],
[https://trac.osgeo.org/grass/wiki/GSoC/2018 2018],
[https://trac.osgeo.org/grass/wiki/GSoC/2019 2019],
[https://trac.osgeo.org/grass/wiki/GSoC/2020 2020],
[https://trac.osgeo.org/grass/wiki/GSoC/2021 2021],
[https://trac.osgeo.org/grass/wiki/GSoC/2022 2022],
[https://trac.osgeo.org/grass/wiki/GSoC/2023 2023])
which have not yet been implemented.
You can also look at accepted GRASS GSoC [https://trac.osgeo.org/grass/wiki/GSoC projects from previous years] for an idea of scope.''

Include "GRASS GIS" in the title of our idea to easily distinguish ideas and projects inside OSGeo.

=== Parallelization of existing tools ===

There are several tools that would benefit from parallelization with OpenMP, e.g. r.texture, r.horizon, r.fill.stats, r/v.surf.idw, r.viewshed, v.to.rast, r.grow.distance, v.surf.bspline, ...
For overview of current state, see [[Raster_Parallelization_with_OpenMP]].

* Requirements: familiarity with C, OpenMP
* Mentor: Huidae Cho
* Co-mentor: Vaclav Petras, Anna Petrasova
* Project length: 175 or 350 hours (take your pick)
* Rating: medium
* Expected Outcomes: parallelized module or modules, depending on complexity
* Test of skills: suggest/implement solution for https://github.com/OSGeo/grass/issues/2644

=== Improve GRASS user experience in Jupyter Notebook ===
[[File:Jupyter_interactive_viewshed.png|500px|thumb|right|InteractiveMap in grass.jupyter library]]
Python package [https://grass.osgeo.org/grass-stable/manuals/libpython/grass.jupyter.html grass.jupyter] was developed during [https://trac.osgeo.org/grass/wiki/GSoC/2021/JupyterAndGRASS GSoC 2021] to simplify running GRASS from Jupyter Notebooks and displaying data. This project could focus on adding features such as adding parallelization for rendering, increasing interactivity of displayed data using ipyleaflet (e.g., capture mouse clicks to show information about vector line, pixel), adding API for managing projects and subprojects (i.e., locations/mapsets), simplifing display of attribute data, ...

* Requirements: Python
* Mentor: Anna Petrasova
* Co-mentor: Vaclav Petras, Helena Mitasova
* Project length: 175 or 350 hours (take your pick)
* Rating: easy to medium
* Expected Outcomes: improved user experience when using GRASS through notebooks
* Test of skills: https://github.com/OSGeo/grass/issues/3276, or write a test for [https://github.com/OSGeo/grass/tree/main/python/grass/jupyter grass.jupyter library] using python unittest or pytest, more info [https://grass.osgeo.org/grass-devel/manuals/libpython/gunittest_testing.html here].

=== Add JSON output to different tools in C ===
There are several tools in GRASS that would benefit from a JSON-formatted output, see [https://github.com/OSGeo/grass/issues/3020 this issue for a list of tools]. Besides adding the JSON output, the work would also include adding tests and basic documentation.
* Requirements: C, Python for tests
* Mentor: Vaclav Petras
* Co-mentor: Anna Petrasova, Corey White
* Project length: 175 or 350 hours (take your pick)
* Rating: easy to medium
* Expected Outcomes: one or more (depending on project length and complexity of the tool) tools with well tested JSON output
* Test of skills: Address https://github.com/OSGeo/grass/issues/1044 for r.surf.fractal

=== Support writing tests with pytest ===

* The current testing framework, ''[https://grass.osgeo.org/grass-stable/manuals/libpython/gunittest.html grass.gunittest]'', was written before migration to Git/GitHub and when long free runs in 3rd party services were unthinkable. Additionally, some no longer relevant goals were prioritized, such as independence on the current code, detailed custom HTML reports, success tracking over time, and high specialization towards GRASS-specifics.
* ''grass.gunittest'' is based on Python ''unittest'' package and many projects since then migrated to //pytest//, e.g., GDAL and Numpy. While ''unittest'' is inspired by Java's JUnit, ''pytest'' is designed to support writing small, readable tests, and uses plain `assert` statements instead of many different assert methods.
* Using ''pytest'' should lead to tests which feel more like Python scripts and to minimum of testing-specific code.
* An example issue of ''grass.gunittest'' is that it doesn't work well with tests of the main GRASS executable (prominence of `grass ... --exec` is yet another new thing which changed since ''grass.gunittest'' was designed).
* Two main things needed:
** Create general comparison functions from the ''grass.gunittest'' assert methods so that they can be used with pytest.
** Current grass.script.setup.init function and grass.script.core.create_location function don't work well in the context of a pytest test function. More
* Additional things needed:
** Fixture for pytest to set up and tear down a GRASS session in a temporary mapset.

* Requirements: Python
* Project length: 175 or 350 hours (take your pick)
* Mentor: Vaclav Petras
* Co-mentor: Stefan Blumentrath
* Proposed by: Vaclav Petras
* Rating: easy to medium
* Expected Outcomes: Convenient way of writing tests with pytest
* Test of skills: Fix failing tests and/or write new tests (more is better). Alternatively, addressing a smaller problem in the testing framework is a good task, too.

=== New easy-to-use CLI and API for GRASS GIS ===

* Make running of GRASS GIS modules as easy as it is to run GDAL commands.
** `grass run r.slope.aspect elevation=elevation.tiff slope=slope.tiff aspect=aspect.tiff`
** CLI like GDAL has.
** No GRASS Database, Location, Mapset to deal with.
** No import, export from user perspective.
** Reasonable defaults for things like region.
** CLI and API still allows user to specify any of the above.
* Idea page with details: wiki:GSoC/2021/EasyToUseCliAndApiIdea
* Project length: 350 hours
* Rating: medium
* Requirements:
** Language: Python
** Proposal: Student needs to show sufficient understanding of the GRASS GIS Database structure and significantly extend on text below in terms of more concrete formulation of ideas and identification of missing and existing parts.
* Mentors: Vaclav Petras
* Co-mentors: Stefan Blumentrath
* Proposed by: Vaclav Petras
* Expected outcomes: New subcommand which easily runs a GRASS module on GeoTiff and GeoPackage.
* Test and training tasks:
** Solve one of the tickets linked at the idea page.
** Add features to `grass` executable interface:
*** Make it possible to associate `*.gxw` files with `grass` executable (#1204) or at least add `--gui-workspace` or preferably just recognize it in the command line (distinguish it from database/location/mapset).
** Extend `--exec` functionality:
*** Add `--region` to set a temporary computational region for the execution, e.g. `--region="raster=raster_name"`
*** Add `--import-raster=some/file.tiff` which imports (r.import) a raster file (same for vector and similarly for export).
*** Add `--link-raster=some/file.tiff` which links (r.external) a raster file (same for vector and similarly for r.external.out).

=== STAC (SpatioTemporal Asset Catalog) Integration ===

Create new import and export capabilities for GRASS GIS which allow users to easily ingest data from STAC catalogs and export locations and mapsets as STAC specs for data discovery within STAC browsers.

* Requirements: familiar with python, STAC specs
* Mentor: Corey White
* Co-mentor: Vaclav Petras, Anna Petrasova
* Project length: 175 or 350 hours (take your pick)
* Rating: medium
* Expected Outcomes: completion of t.in.stac and t.out.stac
* Test of skills:
** suggest or implement solution for implementing t.out.stac using the prototype STAC spec https://github.com/tomorrownow/grass-stac-extension
** suggest/implement solution for completing https://github.com/OSGeo/grass-addons/pull/802

=== Add EODAG support to GRASS GIS ===

[https://eodag.readthedocs.io/en/stable/ EODAG] is a Python library useful to download several satellite datasets from different providers (i.e., USGS, Copernicus, AWS, Planetary Computer, etc.). GRASS has various modules to download satellite data like i.sentinel.download, i.landsat.download, i.modis.download. However, they all use different libraries, some of them no longer maintained. Hence, implementing the use of EODAG as back-end for those tools would be very useful not only in terms of maintenance but also in terms of less code repetition. It would also open the possibility for new tools or a master tool to download other datasets directly from GRASS.

* Requirements: familiar with Python
* Project length: 175 or 350 hours
* Mentor: Luca Delucchi
* Co-mentor: Veronica Andreo
* Proposed by: Luca Delucchi
* Rating: medium
* Expected Outcomes: 175 hours EODAG core library to be able to download products; 350 library + application at least to i.sentinel.download but hopefully also to i.landsat.download
* Test of skills: https://github.com/OSGeo/grass-addons/issues/1033

=== GUI: Add space-time datasets support in Data Catalog ===
[[File:GUI_data_tab.png|400px|thumb|right|Data catalog]]
Currently GRASS Data Catalog shows only raster and vector maps. The goal of this project is to add support for space-time datasets. It is mainly space-time raster datasets. In the next phase of the project support for other types of space-time datasets (vector and 3D raster) could be added. Besides displaying space-time datasets in the layer tree, it is also about adding the equivalent functionality currently available for raster and vector layers from the context menu.

* Requirements: familiar with Python
* Project length: 175 or 350 hours
* Mentor: Martin Landa
* Co-mentor: Anna Petrasova
* Proposed by: Martin Landa
* Rating: medium
* Expected Outcomes: 175 hours basic support for space-time raster datasets; 350 extended support also for other space-time datasets types (vector, 3D raster)
* Test of skills:
** suggest/implement solution for completing https://github.com/OSGeo/grass/issues/2599

=== Add {your research idea} to GRASS GIS ===

* In general, you can propose any topic, but you can specifically propose integrating your research or research idea into GRASS GIS.
* Requirements:
** Language:
*** Depends on the project, often Python, sometimes C.
*** Adding your latest ecological analysis
** Proposal:
*** Discuss relevance to GRASS GIS.
*** Describe technical steps needed for integration.
*** Describe whether it is an addition of a tool (module) or a change in one of the libraries. If it is a tool, specify if it should be included in the core grass repository or in grass-addons repository and why.
*** Specify what research was done and what needs to be accomplished in order to have usable product at the end of summer.
*** Specify who will provide the research expertise.
* Project length: 175 or 350 hours (take your pick)
* Rating: from low to hard
* Mentors:
** GRASS GIS project will provide technical mentors, but it is up to the applicant to ensure the research part is mentored well. An exception may be granted to applicants which can demonstrate that the research is finished or that they have enough expertise themselves.
** Possible technical mentors: Vaclav Petras, Anna Petrasova
** Research mentors: Bring in an expert from your field, e.g., your academic advisor or project principal investigator (if needed).
* Proposed by: Vaclav Petras
* Expected outcome: Working feature which is integrated and merged at the end of the project.
* Test and training tasks:
** Create a test in Python for an existing tool in the grass-addons repository or in the core grass repository.

=== Title of idea ===

Description here

* Requirements:
* Project length: (175 or 350 hours)
* Mentor:
* Proposed by:
* Rating:
* Expected Outcomes:
* Test of skills:
* Other:

== Tips for students ==

* If you have your own ideas we encourage you to propose them. Explain them on the [https://lists.osgeo.org/listinfo/grass-dev grass-dev mailing list].
* If you like some idea here or from previous yeas, write about it on [https://lists.osgeo.org/listinfo/grass-dev grass-dev mailing list] and any ideas of your own which could improve it.
* Follow some good practices in your ideas and proposals:
** Stress why the project would be useful.
** Show that you know how you will proceed. That is, make sure that you can demonstrate that the proposal is feasible in the given time frame.
** Be specific in the implementation (or at least as specific as you can).
** Explain what the final product will look like and how it will work. You can add drawings or mock-ups.
** Explain how the idea relates to existing GRASS GIS functions, features, and needs.
** Do not include steps such as "install GRASS", "compile GRASS libraries (on my machine)", "read about the API". You should do this before applying to GSoC.
* Compile GRASS GIS from source and prepare environment for development:
** Read [https://github.com/OSGeo/grass/blob/main/CONTRIBUTING.md CONTRIBUTING file] and [https://grasswiki.osgeo.org/wiki/Compile_and_Install compilation instructions].
** If you get stuck with the setup, feel free to consult the [https://lists.osgeo.org/listinfo/grass-user grass-user mailing list].
** Familiarize yourself with wiki:Submitting rules.
* Prove your worth by being active on the GRASS mailing lists ([https://lists.osgeo.org/listinfo/grass-user grass-user], [https://lists.osgeo.org/listinfo/grass-dev grass-dev]) or other channels ([https://github.com/OSGeo/grass/discussions GitHub Discussions], [https://gitter.im/grassgis/community Gitter]), fix some [https://github.com/OSGeo/grass/issues bugs], and/or implement some (smaller) features, or write some (simpler) GRASS module, and post it to mailing list. There's no better way to demonstrate your willingness and abilities. Do this before start you apply to GSoC.
* Also note that fixing existing bugs and/or implementing enhancements will be a part of student evaluation.

* Every year GRASS GIS hopes to participate and participates in GSoC as part of the [https://www.osgeo.org/ OSGeo Foundation]'s GSoC program umbrella. See the official OSGeo template for application details and other important information at the [https://wiki.osgeo.org/wiki/Google_Summer_of_Code_Recommendations_for_Students OSGeo Recommendations for Students].

{{GSoC}}

GRASS GSoC 2024 Improve user experience in Jupyter Notebooks

2024-05-11T10:18:09Z

29riyasaxena: GRASS GSoC 2024 Project Update: Enhancing User Experience in Jupyter Notebooks by Riya

== GSoC 2024: Improve GRASS user experience in Jupyter Notebook ==
{| class="wikitable"
| '''Student Name''' || Riya
|-
| '''Organization''' || [https://www.osgeo.org/ OSGeo - Open Source Geospatial Foundation]
|-
| '''Mentor Name''' || Anna Petrasova, Corey White
|-
| '''GitHub Fork''' || [https://github.com/29riyasaxena/grass View Repo]
|-
| '''GSoC proposal''' || [https://hackmd.io/@riyasaxena/HkrKuQJyR View Proposal]
|}

== Abstract ==
The [https://grass.osgeo.org/grass83/manuals/libpython/grass.jupyter.html#module-grass.jupyter.interactivemap grass.jupyter.InteractiveMap()] tool offers basic map visualization features like zooming and layer addition but suffers from suboptimal rendering speed (approximately 7.55 seconds per loop) and cumbersome data integration, particularly with large datasets. Additionally, its reliance on the Pseudo-Mercator projection limits its versatility. This abstract highlights the need for enhancements to improve rendering efficiency, streamline data integration, and broaden projection support for increased usability and functionality.

== Goal ==

Main Goals:
# Enhance InteractiveMap with interactive data retrieval features, enabling users to query attribute values and draw geometries directly on the map.
# Implement support for custom coordinate reference systems (CRS) in InteractiveMap to eliminate the need for layer reprojection and improve visualization speed.
# Optimize rendering processes for SeriesMap and TimeseriesMap by parallelizing map rendering using standard Python libraries like multiprocessing.

Stretch Goals:
# Improve integration between GRASS and Pandas for smoother data handling and analysis.
# Incorporate tile-based rendering to efficiently display extensive datasets without compromising performance.
# Integrate a graphical user interface (GUI) within a Jupyter Notebook for enhanced user experience and ease of interaction with InteractiveMap functionalities.

== Timeline ==
{| class="wikitable"
!Period !! Timeline !! Tasks !! Status
|-
| Bonding Period
||
May 1- May 26
||
# Initial research
# Proposal Discussion with Mentor
# Work on this [https://github.com/OSGeo/grass/pull/3468/ PR]
||
|-
| rowspan="13" | Official Coding Period
|-
| '''Week 1''' (May 27 - June 1) || Write initial function for adding button to ''grass.jupyter.InteractiveMap()'' ||
|-
| '''Week 2''' (June 2 - June 8) || Add click to see attributes features to the button ||
|-
| '''Week 3''' (June 9 - June 15) || Add button to allow users to create drawings in the displayed ''InteractiveMap()'' ||
|-
| '''Week 4''' (June 16 - June 22) || Add tools to the button to create different drawings ||
|-
| '''Week 5''' (June 23 - June 29) || Add functionality to retrieve points from user drawn drawings and add them to the data, if the user wants ||
|-
| '''Week 6''' (June 30 - July 6) || Speeding up the rendering of ''InteractiveMap()'' by skipping reprojection ||
|-
|style="background: #ffdead;"| '''Week 7''' (July 7 - July 13)
||
# Code refactoring, testing, documentation
# '''Mid-term Evaluation: July 12'''
||
|-
| '''Week 8''' (July 14 - July 20) || Adding parallelization to ''TimeseriesMap'' and ''SeriesMap'' ||
|-
| '''Week 9''' (July 21 - July 27) || Documentation, testing, writing tutorial ||
|-
| '''Week 10''' (July 28 - August 3) || Working on a selected stretch goal ||
|-
| '''Week 11''' (August 4 - August 10) || Working on a selected stretch goal
||
|-
| '''Week 12''' (August 11 - August 17) || Write project summary ||
|-
| rowspan="2" | Evaluation Period
|-
| August 26 - September 2 || Submit code and final evaluation ||
|}

== Reports ==