GRASS-Wiki - User contributions [en]

GRASS GSoC 2024 Add JSON output

2024-08-22T20:00:12Z

Juno: /* Examples */

Accepted Google Summer of Code 2024 project.

{| {{table}}
|Student Name: || [[User:juno|Kriti Birda]]
|-
|Organization: || [https://www.osgeo.org OSGeo - Open Source Geospatial Foundation]
|-
| Mentor Name: || Corey White and Vaclav Petras
|-
| Title: || '''Add JSON output to different GRASS tools in C'''
|-
|}

;Abstract
::At the moment, most of the tools in Grass have custom human readable outputs in plain text. Some of these modules could benefit from storing their output in a portable and commonly used data format. The aim of my project is to use the parson library in various tools so that they can produce JSON outputs. The addition of JSON as an output format will be accompanied with addition of Python test cases to verify the output works as intended and to avoid regressions in future. An option to specify the desired output format (plain or JSON) will also be added to each of the tools updated. The layout of the JSON format will be discussed with mentors prior to implementation and will be optimized towards easy ingestion with Pandas.

__TOC__

== Pull Requests ==
{| class="wikitable"
|+
|-
! Module !! PR Title !! PR Link !! Status at end of GSoC Period
|-
| lib || add standard parser option for JSON formatting || https://github.com/OSGeo/grass/pull/3704/ || merged
|-
| r.info || add JSON output || https://github.com/OSGeo/grass/pull/3744/ || merged
|-
| v.info || add JSON output || https://github.com/OSGeo/grass/pull/3755/ || merged
|-
| r.univar || add JSON output || https://github.com/OSGeo/grass/pull/3783/ || merged
|-
| v.univar || add JSON output || https://github.com/OSGeo/grass/pull/3784/ || merged
|-
| r.profile || add JSON output || https://github.com/OSGeo/grass/pull/3872/ || merged
|-
| r.stats || add JSON output || https://github.com/OSGeo/grass/pull/3884/ || open
|-
| r.report || add JSON output || https://github.com/OSGeo/grass/pull/3935/ || merged
|-
| g.region || add JSON output || https://github.com/OSGeo/grass/pull/3941/ || merged
|-
| v.distance || add JSON output || https://github.com/OSGeo/grass/pull/3942/ || open
|-
| r.category || add JSON output || https://github.com/OSGeo/grass/pull/4018/ || merged
|-
| v.category || add JSON output || https://github.com/OSGeo/grass/pull/4020/ || open
|-
| db.describe || add JSON output || https://github.com/OSGeo/grass/pull/4021/ || merged
|-
| v.to.db || add JSON output || https://github.com/OSGeo/grass/pull/4036/ || open
|-
| g.proj || add JSON output || https://github.com/OSGeo/grass/pull/4104/ || open
|-
| r.object.geometry || add JSON output || https://github.com/OSGeo/grass/pull/4105/ || merged
|-
| g.region || fix ruff lint error in tests || https://github.com/OSGeo/grass/pull/4167/ || merged
|-
| db.describe || fix illegal memory access report || https://github.com/OSGeo/grass/pull/4202/ || merged
|}

== Reports ==

Introduction: https://discourse.osgeo.org/t/gsoc-2024-introduction-juno/28253

Community Bonding Period: https://discourse.osgeo.org/t/gsoc-2024-week-0-report-add-json-support-to-grass-modules/28299

# Week 1: https://discourse.osgeo.org/t/gsoc-2024-week-1-report-add-json-support-to-grass-modules/30673
# Week 2: https://discourse.osgeo.org/t/gsoc-2024-week-2-report-add-json-support-to-grass-modules/30764
# Week 3: https://discourse.osgeo.org/t/gsoc-2024-week-3-report-add-json-support-to-grass-modules/30791
# Week 4: https://discourse.osgeo.org/t/gsoc-2024-week-4-report-add-json-support-to-grass-modules/30834
# Week 5: https://discourse.osgeo.org/t/gsoc-2024-week-5-report-add-json-support-to-grass-modules/30882
# Week 6: https://discourse.osgeo.org/t/gsoc-2024-week-6-report-add-json-support-to-grass-modules/30906
# Week 7: https://discourse.osgeo.org/t/gsoc-2024-week-7-report-add-json-support-to-grass-modules/30946
# Week 8: https://discourse.osgeo.org/t/gsoc-2024-week-8-report-add-json-support-to-grass-modules/30993
# Week 9: https://discourse.osgeo.org/t/gsoc-2024-week-9-report-add-json-support-to-grass-modules/31007
# Week 10: https://discourse.osgeo.org/t/gsoc-2024-week-10-report-add-json-support-to-grass-modules/49643
# Week 12: https://discourse.osgeo.org/t/gsoc-2024-week-12-report-add-json-support-to-grass-modules/49735

Final: https://discourse.osgeo.org/t/gsoc-2024-final-report-add-json-output-to-different-tools-in-c/49784
{{GSoC}}

== Final Report ==

=== The State of the Art Before GSoC ===
Before this project, the majority of GRASS GIS tools produced outputs in plain text, which required manual parsing or conversion to be used in other software systems. Some modules already had JSON support, but the implementation was inconsistent, using different flags or options. This made it challenging to automate tasks or integrate GRASS GIS outputs directly with modern data processing pipelines.

=== The Addition (Added Value) That My Project Brought to the Software ===
The project brought significant improvements by adding JSON output support to 16 GRASS GIS tools. This enhancement allows users to specify their desired output format (plain text or JSON), making it easier to integrate with data analysis tools and workflows. Additionally, the project standardized the options for tools that already had JSON support, improving consistency across the platform. The introduction of comprehensive Python test cases for these outputs ensures that the enhancements are reliable and future-proof.

=== Potential Future Work ===
JSON support for 4 modules is currently a work in progress and should hopefully be complete soon. Further work is needed to extend JSON output support to the remaining tools within GRASS GIS. Future developers can build on this foundation, focusing on additional modules or enhancing the JSON schema to support more complex use cases.

== Examples ==

=== Using r.category JSON output with python ===
<source lang="python">
import grass.script as gs
output = gs.read_command(
"r.category",
map="towns",
output_format="json"
)
categories = json.loads(output)
print(categories)
</source>

<pre>
[
{
"category": 1,
"description": "CARY"
},
{
"category": 2,
"description": "GARNER"
},
{
"category": 3,
"description": "APEX"
},
{
"category": 4,
"description": "RALEIGH-CITY"
},
{
"category": 5,
"description": "RALEIGH-SOUTH"
},
{
"category": 6,
"description": "RALEIGH-WEST"
}
]
</pre>

=== Using r.profile JSON output with pandas and matplotlib ===
<source lang="python">
import grass.script as gs
import pandas as pd
import matplotlib.pyplot as plt

# Run r.profile command
elevation = gs.read_command(
"r.profile",
input="elevation",
coordinates="641712,226095,641546,224138,641546,222048,641049,221186",
format="json",
flags="gc"
)

df = pd.read_json(elevation)
print(df)

# Convert the RGB color values to hex format for matplotlib
df["color"] = df.apply(lambda x: "#{:02x}{:02x}{:02x}".format(int(x["red"]), int(x["green"]), int(x["blue"])), axis=1)

# Create the scatter plot
plt.figure(figsize=(10, 6))
plt.scatter(df['distance'], df['elevation'], c=df['color'], marker='o')
plt.title('Profile of Distance vs. Elevation with Color Coding')
plt.xlabel('Distance (meters)')
plt.ylabel('Elevation')
plt.grid(True)
plt.show()
</source>
<pre>
easting northing distance elevation red green blue color
0 641712.000000 226095.000000 0.000000 84.530815 111 255 0 #6fff00
1 641669.739905 225596.789117 500.000000 97.633720 255 244 0 #fff400
2 641627.479809 225098.578233 1000.000000 104.868874 255 198 0 #ffc600
3 641585.219714 224600.367350 1500.000000 97.171303 255 247 0 #fff700
4 641546.000000 224138.000000 1964.027749 81.972504 79 255 0 #4fff00
5 641546.000000 223638.000000 2464.027749 72.764458 0 245 29 #00f51d
6 641546.000000 223138.000000 2964.027749 80.820168 64 255 0 #40ff00
7 641546.000000 222638.000000 3464.027749 71.326347 0 241 42 #00f12a
8 641546.000000 222138.000000 3964.027749 71.669518 0 242 39 #00f227
9 641546.000000 222048.000000 4054.027749 71.669518 0 242 39 #00f227
10 641296.254788 221614.840296 4554.027749 78.522743 35 255 0 #23ff00
</pre>

[[File:Distance Elevation Color Coded.png]]

=== Using r.info JSON output with jq ===
<source lang="bash">
r.info lakes format=json | jq '.title'
</source>
<pre>
"South-West Wake county: Wake county lakes"
</pre>

GRASS GSoC 2024 Add JSON output

2024-08-22T19:59:22Z

Juno: Add examples

Accepted Google Summer of Code 2024 project.

{| {{table}}
|Student Name: || [[User:juno|Kriti Birda]]
|-
|Organization: || [https://www.osgeo.org OSGeo - Open Source Geospatial Foundation]
|-
| Mentor Name: || Corey White and Vaclav Petras
|-
| Title: || '''Add JSON output to different GRASS tools in C'''
|-
|}

;Abstract
::At the moment, most of the tools in Grass have custom human readable outputs in plain text. Some of these modules could benefit from storing their output in a portable and commonly used data format. The aim of my project is to use the parson library in various tools so that they can produce JSON outputs. The addition of JSON as an output format will be accompanied with addition of Python test cases to verify the output works as intended and to avoid regressions in future. An option to specify the desired output format (plain or JSON) will also be added to each of the tools updated. The layout of the JSON format will be discussed with mentors prior to implementation and will be optimized towards easy ingestion with Pandas.

__TOC__

== Pull Requests ==
{| class="wikitable"
|+
|-
! Module !! PR Title !! PR Link !! Status at end of GSoC Period
|-
| lib || add standard parser option for JSON formatting || https://github.com/OSGeo/grass/pull/3704/ || merged
|-
| r.info || add JSON output || https://github.com/OSGeo/grass/pull/3744/ || merged
|-
| v.info || add JSON output || https://github.com/OSGeo/grass/pull/3755/ || merged
|-
| r.univar || add JSON output || https://github.com/OSGeo/grass/pull/3783/ || merged
|-
| v.univar || add JSON output || https://github.com/OSGeo/grass/pull/3784/ || merged
|-
| r.profile || add JSON output || https://github.com/OSGeo/grass/pull/3872/ || merged
|-
| r.stats || add JSON output || https://github.com/OSGeo/grass/pull/3884/ || open
|-
| r.report || add JSON output || https://github.com/OSGeo/grass/pull/3935/ || merged
|-
| g.region || add JSON output || https://github.com/OSGeo/grass/pull/3941/ || merged
|-
| v.distance || add JSON output || https://github.com/OSGeo/grass/pull/3942/ || open
|-
| r.category || add JSON output || https://github.com/OSGeo/grass/pull/4018/ || merged
|-
| v.category || add JSON output || https://github.com/OSGeo/grass/pull/4020/ || open
|-
| db.describe || add JSON output || https://github.com/OSGeo/grass/pull/4021/ || merged
|-
| v.to.db || add JSON output || https://github.com/OSGeo/grass/pull/4036/ || open
|-
| g.proj || add JSON output || https://github.com/OSGeo/grass/pull/4104/ || open
|-
| r.object.geometry || add JSON output || https://github.com/OSGeo/grass/pull/4105/ || merged
|-
| g.region || fix ruff lint error in tests || https://github.com/OSGeo/grass/pull/4167/ || merged
|-
| db.describe || fix illegal memory access report || https://github.com/OSGeo/grass/pull/4202/ || merged
|}

== Reports ==

Introduction: https://discourse.osgeo.org/t/gsoc-2024-introduction-juno/28253

Community Bonding Period: https://discourse.osgeo.org/t/gsoc-2024-week-0-report-add-json-support-to-grass-modules/28299

# Week 1: https://discourse.osgeo.org/t/gsoc-2024-week-1-report-add-json-support-to-grass-modules/30673
# Week 2: https://discourse.osgeo.org/t/gsoc-2024-week-2-report-add-json-support-to-grass-modules/30764
# Week 3: https://discourse.osgeo.org/t/gsoc-2024-week-3-report-add-json-support-to-grass-modules/30791
# Week 4: https://discourse.osgeo.org/t/gsoc-2024-week-4-report-add-json-support-to-grass-modules/30834
# Week 5: https://discourse.osgeo.org/t/gsoc-2024-week-5-report-add-json-support-to-grass-modules/30882
# Week 6: https://discourse.osgeo.org/t/gsoc-2024-week-6-report-add-json-support-to-grass-modules/30906
# Week 7: https://discourse.osgeo.org/t/gsoc-2024-week-7-report-add-json-support-to-grass-modules/30946
# Week 8: https://discourse.osgeo.org/t/gsoc-2024-week-8-report-add-json-support-to-grass-modules/30993
# Week 9: https://discourse.osgeo.org/t/gsoc-2024-week-9-report-add-json-support-to-grass-modules/31007
# Week 10: https://discourse.osgeo.org/t/gsoc-2024-week-10-report-add-json-support-to-grass-modules/49643
# Week 12: https://discourse.osgeo.org/t/gsoc-2024-week-12-report-add-json-support-to-grass-modules/49735

Final: https://discourse.osgeo.org/t/gsoc-2024-final-report-add-json-output-to-different-tools-in-c/49784
{{GSoC}}

== Final Report ==

=== The State of the Art Before GSoC ===
Before this project, the majority of GRASS GIS tools produced outputs in plain text, which required manual parsing or conversion to be used in other software systems. Some modules already had JSON support, but the implementation was inconsistent, using different flags or options. This made it challenging to automate tasks or integrate GRASS GIS outputs directly with modern data processing pipelines.

=== The Addition (Added Value) That My Project Brought to the Software ===
The project brought significant improvements by adding JSON output support to 16 GRASS GIS tools. This enhancement allows users to specify their desired output format (plain text or JSON), making it easier to integrate with data analysis tools and workflows. Additionally, the project standardized the options for tools that already had JSON support, improving consistency across the platform. The introduction of comprehensive Python test cases for these outputs ensures that the enhancements are reliable and future-proof.

=== Potential Future Work ===
JSON support for 4 modules is currently a work in progress and should hopefully be complete soon. Further work is needed to extend JSON output support to the remaining tools within GRASS GIS. Future developers can build on this foundation, focusing on additional modules or enhancing the JSON schema to support more complex use cases.

== Examples ==

=== Using r.category JSON output with python ===
<source lang="python">
import grass.script as gs
output = gs.read_command(
"r.category",
map="towns",
output_format="json"
)
categories = json.loads(output)
print(categories)
</source>

<pre>
[
{
"category": 1,
"description": "CARY"
},
{
"category": 2,
"description": "GARNER"
},
{
"category": 3,
"description": "APEX"
},
{
"category": 4,
"description": "RALEIGH-CITY"
},
{
"category": 5,
"description": "RALEIGH-SOUTH"
},
{
"category": 6,
"description": "RALEIGH-WEST"
}
]
</pre>

=== Using r.profile JSON output with pandas and matplotlib ===
<source lang="python">
import grass.script as gs
import pandas as pd
import matplotlib.pyplot as plt

# Run r.profile command
elevation = gs.read_command(
"r.profile",
input="elevation",
coordinates="641712,226095,641546,224138,641546,222048,641049,221186",
format="json",
flags="gc"
)

df = pd.read_json(elevation)
print(df)

# Convert the RGB color values to hex format for matplotlib
df["color"] = df.apply(lambda x: "#{:02x}{:02x}{:02x}".format(int(x["red"]), int(x["green"]), int(x["blue"])), axis=1)

# Create the scatter plot
plt.figure(figsize=(10, 6))
plt.scatter(df['distance'], df['elevation'], c=df['color'], marker='o')
plt.title('Profile of Distance vs. Elevation with Color Coding')
plt.xlabel('Distance (meters)')
plt.ylabel('Elevation')
plt.grid(True)
plt.show()
</source>
<pre>
easting northing distance elevation red green blue color
0 641712.000000 226095.000000 0.000000 84.530815 111 255 0 #6fff00
1 641669.739905 225596.789117 500.000000 97.633720 255 244 0 #fff400
2 641627.479809 225098.578233 1000.000000 104.868874 255 198 0 #ffc600
3 641585.219714 224600.367350 1500.000000 97.171303 255 247 0 #fff700
4 641546.000000 224138.000000 1964.027749 81.972504 79 255 0 #4fff00
5 641546.000000 223638.000000 2464.027749 72.764458 0 245 29 #00f51d
6 641546.000000 223138.000000 2964.027749 80.820168 64 255 0 #40ff00
7 641546.000000 222638.000000 3464.027749 71.326347 0 241 42 #00f12a
8 641546.000000 222138.000000 3964.027749 71.669518 0 242 39 #00f227
9 641546.000000 222048.000000 4054.027749 71.669518 0 242 39 #00f227
10 641296.254788 221614.840296 4554.027749 78.522743 35 255 0 #23ff00
</pre>

[[File:Distance Elevation Color Coded.png]]

<source lang="bash">
r.info lakes format=json | jq '.title'
</source>
<pre>
"South-West Wake county: Wake county lakes"
</pre>

File:Distance Elevation Color Coded.png

2024-08-22T19:45:46Z

Juno:

Profile of Distance vs. Elevation with Color Coding

GRASS GSoC 2024 Add JSON output

GRASS GSoC 2024 Add JSON output

2024-05-11T08:49:46Z

Juno:

Accepted Google Summer of Code 2024 project.

{| {{table}}
|Student Name: || [[User:juno|Kriti Birda]]
|-
|Organization: || [http://www.osgeo.org OSGeo - Open Source Geospatial Foundation]
|-
| Mentor Name: || Corey White and Vaclav Petras
|-
| Title: || '''Add JSON output to different GRASS tools in C'''
|-
|}

;Abstract
::At the moment, most of the tools in Grass have custom human readable outputs in plain text. Some of these modules could benefit from storing their output in a portable and commonly used data format. The aim of my project is to use the parson library in various tools so that they can produce JSON outputs. The addition of JSON as an output format will be accompanied with addition of Python test cases to verify the output works as intended and to avoid regressions in future. An option to specify the desired output format (plain or JSON) will also be added to each of the tools updated. The layout of the JSON format will be discussed with mentors prior to implementation and will be optimized towards easy ingestion with Pandas.
__TOC__
== Application ==

GRASS GSoC Ideas 2024

2024-05-11T08:43:50Z

Juno: /* Add JSON output to different GRASS tools in C */

== 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
* 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 Add JSON output

2024-05-11T08:42:39Z

Juno: Created page with "Grass GIS JSON Format Support Project"

Grass GIS JSON Format Support Project