Hello, and welcome to this project about the management and curation of the resources hosted in EarthPortal. The work is carried out within Data Terra as a six-month internship.
Each subfolder of this repository is dedicated to a specific activity and has its own README with more details:
docs/: short reports written during the internship, such as the quick reference table (cheatsheet) for the OntoPortal Metadata Guidelines and the state of the art of EarthPortal.earthportal_sa_audit/: state of the art of the semantic artefacts currently hosted in the EarthPortal catalogue (O'FAIRe scores, comparison with the Metadata Guidelines, one audit per artefact).- Other folders are coming soon.
To learn more about a subfolder, please open its README first.
Our development environment runs smoothly on:
- Ubuntu 24.04.3 LTS (required: or any modern Linux system)
- Python 3.12.3 (required: 3.12 or later; check with
python3 --version) - Git 2.43.0 (required: check with
git --version) - Visual Studio Code 1.109.3 (optional: use any editor you like!)
You also need an EarthPortal API key: create an account on earthportal.eu, then copy the key shown on your account page.
- Clone the repository and move into it:
git clone https://github.com/EarthPortal/SA_Management.git
cd SA_Management- Create and activate a virtual environment:
python3 -m venv .venv
source .venv/bin/activate- Install the Python dependencies:
pip install -r requirements.txt- (Optional) Register a Jupyter kernel, if you want to run notebooks:
python3 -m ipykernel install --user --name data-terra-venv --display-name "Data Terra (.venv)"- Create your
.envfile from the template, then write your API key in it:
cp .env.example .env
nano .env # or open it in VS CodeNote:
.envholds your personal API key. It is listed in.gitignore: never commit it and never share it. Several folders of this repository reads this single file.
If you already set up the project and only want the latest changes (for example, a new folder you did not have before):
- Move to the project directory:
cd SA_Management- Pull the latest changes:
git pull- Activate your virtual environment:
source .venv/bin/activate- Install any new dependencies:
pip install -r requirements.txt- Compare
.env.examplewith your.env, and add any new variable it lists.
Then open the README of the new folder to learn how to use it.