Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 96 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,108 @@
# Learn GRASS GIS

Welcome to the Learn GRASS GIS repository that hosts a Quarto-powered website
with a collection of tutorials and learning materials for [GRASS
GIS](https://grass.osgeo.org), an open-source platform for geospatial analysis
and modeling. The tutorials cover a variety of topics and is designed to help
users at different skill levels.
## 📌 What is GRASS GIS?
[GRASS GIS](https://grass.osgeo.org) (**Geographic Resources Analysis Support System**) is a **free and open-source Geographic Information System (GIS)** used for geospatial data management, spatial modeling, visualization, and analysis. It supports **raster and vector data processing**, and is widely used in **academia, research, and professional GIS applications**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds old style... You could use the text below GRASS banner in the website instead.

GRASS GIS is a powerful computational engine for raster, vector, and geospatial processing. It supports terrain and ecosystem modeling, hydrology, data management, and imagery processing. With a built-in temporal framework and Python API, it enables advanced time series analysis and rapid geospatial programming, optimized for large-scale analysis on various hardware configurations.


## Contributing
## 🚀 Installation Guide

We welcome all contributions, including fixes, suggestions and complete tutorials.
If you're unsure where to start, feel free to open an issue to discuss your ideas.
### 🔹 1. Prerequisites
Before installing, make sure you have the following dependencies:
- **Git** → [Download Git](https://git-scm.com/downloads)
- **Quarto** → [Install Quarto](https://quarto.org/docs/get-started/)
- **Python** (optional, for Python-based tutorials) → [Download Python](https://www.python.org/downloads/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following the criteria for Python, you might want to suggest R and rgrass for R-based tutorials


To contribute changes, use a "fork and pull request" workflow. This workflow is
explained in the [GitHub
guide](https://github.com/OSGeo/grass/blob/main/doc/development/github_guide.md)
written for OSGeo/grass repository, so just adjust it for this repository.
### 🔹 2. Clone the Repository
To get started, open your terminal and run:
git clone https://github.com/OSGeo/grass-tutorials.git cd grass-tutorials
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
git clone https://github.com/OSGeo/grass-tutorials.git cd grass-tutorials
git clone https://github.com/OSGeo/grass-tutorials.git
cd grass-tutorials


shell
Copy
Edit
Comment on lines +18 to +20
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
shell
Copy
Edit


## License
### 🔹 3. Install Dependencies
Some tutorials may require additional dependencies.

The content in this repository is dual-licensed under the
[GNU Free Documentation License v1.2 or later](https://www.gnu.org/licenses/fdl-1.2.html)
(GFDL-1.2-or-later) and the
[Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)
(CC-BY-SA-4.0).
#### 📌 For Python-based tutorials
pip install -r requirements.txt
Comment on lines +25 to +26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also add the pip install dependency_name suggestion... Not all tutorials will have a requirements.txt file. In any case, as tutorials should be reproducible, if they use dependencies, that should be within the tutorial itself.


## Acknowledgments
shell
Copy
Edit
Comment on lines +28 to +30
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
shell
Copy
Edit

What are these? There are some of them also below, please remove...


The initial content of this website was supported by funding from the
U.S. National Science Foundation [award 2303651](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2303651).
#### 📌 For R-based tutorials (if applicable)
Rscript -e "install.packages(c('tidyverse', 'sf'))"
Comment on lines +32 to +33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above... I'd remove this "Install dependencies" section.


## Contact
csharp
Copy
Edit
Comment on lines +35 to +37
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
csharp
Copy
Edit


For questions or suggestions, feel free to open an issue or reach out to the
maintainers through the [GRASS GIS community channels](https://grass.osgeo.org/community/).
### 🔹 4. Serve the Tutorials Locally
Since this project is powered by **Quarto**, you can preview the website locally:
quarto preview

arduino
Copy
Edit
Comment on lines +43 to +45
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
arduino
Copy
Edit

After running the command, open your browser and go to:
http://localhost:4321

markdown
Copy
Edit
Comment on lines +49 to +51
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
markdown
Copy
Edit

Now, you can browse the tutorials on your local machine.

## 📚 How to Use the Tutorials
- Browse the tutorials directly from the [website](https://grass-tutorials.osgeo.org/).
- Use the **search bar** to find specific topics.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about the categories?

- If you want to modify or contribute new tutorials, check out the **[Contributing](#contributing)** section.

## 🤝 Contributing
We welcome all contributions, including:
- Fixes for existing tutorials
- Suggestions for improvements
- Adding new tutorials

If you're unsure where to start, **open an issue** to discuss your ideas.

### **How to Contribute**
1. **Fork this repository** on GitHub.
2. **Clone your fork**:
git clone https://github.com/YOUR-USERNAME/grass-tutorials.git

markdown
Copy
Edit
Comment on lines +72 to +74
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
markdown
Copy
Edit

3. **Create a new branch**:
git checkout -b my-feature-branch

markdown
Copy
Edit
Comment on lines +78 to +80
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
markdown
Copy
Edit

4. **Make your changes** and commit:
git add . git commit -m "Added new tutorial on XYZ"

markdown
Copy
Edit
Comment on lines +84 to +86
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
markdown
Copy
Edit

5. **Push changes** and create a Pull Request:
git push origin my-feature-branch

markdown
Copy
Edit
Comment on lines +90 to +92
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
markdown
Copy
Edit

For detailed contribution steps, refer to the **[GitHub Contribution Guide](https://github.com/OSGeo/grass/blob/main/doc/development/github_guide.md)**.

## 📜 License
The content in this repository is dual-licensed under:
- **[GNU Free Documentation License v1.2 or later](https://www.gnu.org/licenses/fdl-1.2.html)** (GFDL-1.2-or-later)
- **[Creative Commons Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/)** (CC-BY-SA-4.0)

## 📢 Contact & Community
For questions or suggestions, open an **issue** or reach out via the **[GRASS GIS community channels](https://grass.osgeo.org/community/)**.

### 🎯 Final Notes
- This README now includes **installation steps, usage instructions, and contribution guidelines**.
- The guide ensures **new users** can easily install and explore the tutorials.
- Contributors can now follow a **clear workflow** for making updates.

🎉 **You're all set!** 🚀 Simply replace your existing `README.md` with this co
Comment on lines +103 to +108
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 🎯 Final Notes
- This README now includes **installation steps, usage instructions, and contribution guidelines**.
- The guide ensures **new users** can easily install and explore the tutorials.
- Contributors can now follow a **clear workflow** for making updates.
🎉 **You're all set!** 🚀 Simply replace your existing `README.md` with this co

It's fine to use IA, but please be careful with blind copy-pasting

6 changes: 4 additions & 2 deletions index.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Learn GRASS GIS"
title: "Learn GRASS GIS "
listing:
contents:
- content/tutorials
Expand All @@ -8,5 +8,7 @@ listing:
categories: true
filter-ui: [title, categories]
page-layout: full
description: |
Hands-on tutorials for learning [GRASS GIS](https://grass.osgeo.org), the open-source geospatial processing engine.
title-block-banner: false
---
---