docs: mkdocs index and nav redesign #5207
+191
−148
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,5 +45,3 @@ def build_index(ext): | |
|
|
||
| if __name__ == "__main__": | ||
| build_index("html") | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,128 +39,6 @@ | |
| """ | ||
| ) | ||
|
|
||
| # footer_tmpl = string.Template( | ||
| # r""" | ||
| # ____ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| ## What is GRASS? | ||
|
|
||
| [GRASS](https://grass.osgeo.org/) is a geosptial processing engine for | ||
| advance analysis and visualization of geospatial data. It is a powerful tool for | ||
| processing and analyzing geospatial data sets. GRASS is a free and open source | ||
| software, released under an open source [GNU GPLed](https://www.gnu.org/licenses/gpl.html). | ||
|
|
||
| Downloaded and installed GRASS here. | ||
|
|
||
| <!-- markdownlint-disable-next-line MD013 --> | ||
| [:material-download: Download and Install](https://grass.osgeo.org/download/){ .md-button } | ||
|
|
||
| ## Tutorials | ||
|
|
||
| Get started with GRASS by following the | ||
| [tutorials](https://grass-tutorials.osgeo.org/) below. | ||
|
|
||
| ## Interfaces | ||
|
|
||
| GRASS provides a number of interfaces for interacting with the software. The | ||
| most common interfaces are: | ||
|
|
||
| ### [Terminal](grass.md) | ||
|
|
||
| The terminal interface allows you to start a GRASS session to run GRASS | ||
| commands, execute scripts, or open the GUI. | ||
|
|
||
| Here we creating a new project for the NAD83(HARN)/North Carolina coordinate | ||
| reference system (EPSG:3358) and start a GRASS session in the terminal. | ||
|
|
||
| ```sh | ||
| grass -c EPSG:3358 {project directory} --text | ||
|
|
||
| ``` | ||
|
|
||
| The terminal can now execute GRASS commands. | ||
|
|
||
| ```sh | ||
| g.region raster=elevation | ||
| r.slope.aspect elevation=elevation slope=slope aspect=aspect | ||
| ``` | ||
|
|
||
| To learn more about the terminal interface, see the | ||
| [Terminal Interface](grass.md) page. | ||
|
|
||
| ### Python Scripts | ||
|
|
||
| The `grass.script` module provides a Python interface to GRASS. This allows | ||
| users to write Python scripts to interact with GRASS. The `grass.script` module | ||
|
Comment on lines
+46
to
+49
There was a problem hiding this comment. We need to start describing the in-session version grass.script.setup.init. |
||
| contains the gs.script.core module which provides the core functionality for the | ||
| GRASS Python interface, the `grass.script.raster` module which provides | ||
| functionality for working with raster data, and the `grass.script.vector` module | ||
| which provides functionality for working with vector data. | ||
|
|
||
| To get started Python, create a new project and run the | ||
|
|
||
| ```python | ||
| import sys | ||
| import subprocess | ||
|
|
||
| # Append GRASS to the python system path | ||
| sys.path.append( | ||
| subprocess.check_output(["grass", "--config", "python_path"], text=True).strip() | ||
| ) | ||
|
|
||
| import grass.script as gs | ||
|
|
||
| # Create a new project | ||
| gs.create_project(path=grassdata, name=project_name, epsg="3358", overwrite=False) | ||
|
|
||
| # Run GRASS commands | ||
| gs.run_command('g.region', raster='elevation') | ||
| gs.run_command('r.slope.aspect', elevation='elevation', slope='slope', aspect='aspect') | ||
| ``` | ||
|
|
||
| ### Jupyter Notebooks | ||
|
|
||
| Jupyter Notebooks are a great way to interact with GRASS. The `grass.jupyter` | ||
| module provides a Jupyter interface to GRASS. This allows users to write Jupyter | ||
| Notebooks to interact with GRASS. The `grass.jupyter` module contains the `Map`, | ||
| `InteractiveMap`, `Map3D`, `TimeSeriesMap`, and `SeriesMap` classes which | ||
| provide functionality for working with maps in Jupyter Notebooks. | ||
|
|
||
| ```python | ||
| import grass.jupyter as gj | ||
|
|
||
| session = gj.init(Path(grassdata, project_name)) | ||
|
|
||
| slope_map = gj.Map() # Create a new map | ||
| slope_map.d_rast(map='slope') # Add the slope raster to the map | ||
| slope_map.d_barscale(at=(80, 10)) # Add a bar scale to the map | ||
| slope_map.d_legend(raster='slope', at=(80, 90)) # Add a legend to the map | ||
| slope_map.show() # Display the map | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ### [GRASS Desktop GUI](wxguiintro.md) | ||
|
|
||
| Add content here. | ||
|
|
||
| ## [Project Management](grass_database.md) | ||
|
|
||
| Add Content here. | ||
|
|
||
| ## Processing Tools | ||
cwhite911 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| GRASS provide a wide range of tools for geospatial processing, modeling, | ||
| analysis, and visualization. The tools are organized into categories based | ||
| on the type of data they process. The tools are prefixed with a letter to | ||
| indicate the type of data they process. | ||
|
|
||
| The following table provides a list of the prefixes and the categories they represent. | ||
| Follow the topics links to see a complete list of tools in each category. Or try | ||
| using the search feature to find a specific tool or topic by subject | ||
| matter (e.g. hydrology, landscapes). | ||
|
|
||
| ### GRASS Tools | ||
|
|
||
| | Prefix | Category | Description | Topic | | ||
| |--------|----------------------------------|------------------------------------|-------------------------------------------| | ||
| | `g.` | General | General GIS management tools | [General Tools](general.md) | | ||
| | `r.` | Raster | Raster data processing tools | [Raster Tools](raster.md) | | ||
| | `r3.` | 3D Raster | 3D Raster data processing tools | [3D Raster Tools](raster3d.md) | | ||
| | `v.` | Vector | Vector data processing tools | [Vector Tools](vector.md) | | ||
| | `i.` | Imagery | Imagery processing tools | [Imagery Tools](imagery.md) | | ||
| | `t.` | Temporal | Temporal data processing tools | [Temporal Tools](temporal.md) | | ||
| | `db.` | Database | Database management tools | [Database Tools](database.md) | | ||
| | `d.` | Display | Display and visualization tools | [Display Tools](display.md) | | ||
| | `m.` | Miscellaneous | Miscellaneous tools | [Miscellaneous Tools](miscellaneous.md) | | ||
| | `ps.` | Postscript | Postscript tools | [Postscript Tools](postscript.md) | | ||
|
|
||
| ### Addons | ||
|
|
||
| In addition to the core tools, GRASS also provides a number of addons that | ||
| extend the functionality of GRASS. Addons are part of the [OSGeo/grass-addons](https://github.com/OSGeo/grass-addons) | ||
| repository and are a great place to plubish and share custom tools, models, and reserach. | ||
| The addons are maintained by the GRASS community and are a great way to extend the | ||
| functionality of GRASS. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
C doc and possibly general tool writing stuff (standard parser options): I wonder if to put it here as sort of next steps ("is this not enough?") or at the end to a separate section. This would be the usage as a modeling platform.