https://github.com/ceos-org/eo-glossary
A community glossary of terms related to Earth Observation.
https://github.com/ceos-org/eo-glossary
eo glossary mkdocs mkdocs-material
Last synced: 10 months ago
JSON representation
A community glossary of terms related to Earth Observation.
- Host: GitHub
- URL: https://github.com/ceos-org/eo-glossary
- Owner: ceos-org
- Created: 2025-07-29T13:23:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-29T14:27:50.000Z (11 months ago)
- Last Synced: 2025-07-29T15:56:33.990Z (11 months ago)
- Topics: eo, glossary, mkdocs, mkdocs-material
- Language: Jupyter Notebook
- Homepage: https://ceos-org.github.io/eo-glossary/
- Size: 7.74 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**CURRENTLY IN A TRANSITION PHASE FROM https://github.com/ec-jrc/KCEO-Glossary. For infos please open an issue or contact [Dominik](https://github.com/do-me/).**
# EO Glossary
Bridging EO communities. Contribute to this community-driven glossary and improve or add definitions!
## Contributions and Feedback
The EO Glossary is built for the EO community. Your feedback and ideas are fundamental for the further development of this glossary. PR's and contributions of any kind are highly welcomed.
### Contribution Guide
#### Editing existing terms
Click the top right edit icon on a term page:
#### Adding new terms
If you'd like to add an entirely new term to the glossary, you can do so by using the GitHub UI. Two steps are necessary:
1. Creating a new markdown file under the `docs` directory, e.g. for `Your New Term`
You can copy the template from this file, change the content and commit the changes when you're done.
https://github.com/ceos-org/eo-glossary/blob/main/docs/_template.md
https://github.com/user-attachments/assets/6ac4090d-6aa9-4fd1-be2a-93158fd2dc95
2. Now that the file is created, it must be referenced in `mkdocs.yml` so that the site builder knows where it should appear on the web page. Just open this file and reference it in alphabetic order.
https://github.com/ceos-org/eo-glossary/blob/main/mkdocs.yml
Commit the changes, done.
#### Tags
We currently use the following tag system:
If you want to add or remove tags you need to follow this syntax:
```markdown
---
title: In-Situ Observation
tags:
- to be discussed
---
```
There is a tab in front of every tag followed by a hypen and a space.
We currently use the following tag system for:
1. Discussion status:
- term to add (only tagged in issue/discussion)
- to be defined
- to be discussed
- to be approved
- approved
2. Class of term (from: "Lost in Translation: The Need for Common Vocabularies and an Interoperable Thesaurus in Earth Observation Sciences, to be published", DOI: 10.1007/s10712-024-09854-8)
- base term
- core term
- controversial term
- high-impact term
## Exports
We provide automatic exports as parquet and xlsx [here](https://github.com/ceos-org/eo-glossary/tree/main/exports).
You can convenientely query the parquet exports via httpfs (range requests) and only retrieve the record or records you are interested in without having to download all terms (that might grow substantially in the future). DuckDB for instance enables an SQL-based queries and can either be run from the browser or from your terminal. To get started, follow these steps:
1. [Install DuckDB](https://duckdb.org/)
2. Run e.g. the DuckDB in your terminal with `duckdb -ui`
3. Enter the below SQL query
```sql
-- Load the httpfs extension
INSTALL httpfs;
LOAD httpfs;
-- Query the remote Parquet file
SELECT *
FROM read_parquet('https://github.com/ceos-org/eo-glossary/raw/refs/heads/main/exports/parquet/terms_definition_1.parquet')
WHERE term ilike 'climate projection';
```
Or check what terms include the term `Data` (case sensitive) with:
```sql
-- Load the httpfs extension
INSTALL httpfs;
LOAD httpfs;
-- Query the remote Parquet file
SELECT *
FROM read_parquet('https://github.com/ceos-org/eo-glossary/raw/refs/heads/main/exports/parquet/terms_definition_1.parquet')
WHERE 'Data' in term;
```
## To Do's:
- Update GitHub actions to run custom scripts for cross linking, topology and dependency graph every time. Requires some careful testing. High priority.
- Add contribution guide in this readme. High priority.
- Update landing page search with new terms if found. Requires small Python script. Low priority for now.
- Add versioning with mike.
- Decide about regular GitHub releases (e.g. yearly? or only when a "critial mass" is reached once it's more stable?)
## FAQ
### Mac build error
- If error `ERROR - "cairosvg" Python module is installed, but it crashed with:` just use:
- `export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib` before. Or set it once, e.g. for zsh shell:
- `echo 'export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib' >> ~/.zshrc && source ~/.zshrc`
### Local installation
- best create virtual env with python 3.11 with
- `pip install "mkdocs-material[imaging]==9.5.34"`
- `pip install mkdocs-glightbox mkdocs-minify-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2`
- `mkdocs serve` for local server or `mkdocs build` for the static html with assets
(See also github actions in .github/workflows/ci.yml)