Introduction to Freva: general usage and plugin development

Contribution List

1. Introduction to Freva

12/06/2024, 09:00

Day 1

A comprehensive overview on Freva:
• history and description of the tools
• overview on the main Freva functionalities: data-browser, plugin, history of runs.

12. Hands-on: Freva via web

12/06/2024, 09:40

Day 1

First block of hands-on exercises via Freva web:
- overview of the web-page
- databrowser: learning to find different data through it
- plugin usage: exercise with a couple of tool
- history-results: checking on the runs we did previously, learning how to re-run, share different runs.
- result-browser: history result of everyone

Q&A

13. Set up for 2nd and 3rd hands-on

12/06/2024, 11:00

Day 1

Time to check and solve out problems with DKRZ account, jupyter hub access etc.

14. Hands-on: Freva via command line (option a, depending on poll results)

12/06/2024, 11:20

Day 1

Second block of hands-on exercises via Freva command line (cli):
- overview of the cli functionalities
- databrowser: learning to find different data through it
- plugin usage: exercise with a couple of tool
- history-results: checking on the runs we did previously, learning how to re-run, share different runs.
- user-add: functionalities to add or link your own data.

Q&A

15. Hands-on: Freva via python client (option b, depending on poll results)

12/06/2024, 13:20

Day 1

Third block of hands-on exercises via Freva python client:
- overview of the python functionalities
- databrowser: learning to find different data through it
- plugin usage: exercise with a couple of tool
- history-results: checking on the runs we did previously, learning how to re-run, share different runs.
- user-add: functionalities to add or link your own data.

Q&A

16. closing remarks

12/06/2024, 14:20

Day 1

6. Introduction to a Freva plugin

13/06/2024, 09:00

Day 2

• overall structure of a plugin
• dependencies of a plugin
• git & gitlab, where plugins are located
• typical interaction workflow to move from a tool to a freva-plugin
• licensing of a plugin
• how to connect to levante with e.g. vscode

Q&A

10. Hands-on 1: accessing gitlab and cloning a plugin

13/06/2024, 09:45

Day 2

17. Dissecting a Freva Plugin

13/06/2024, 10:45

Day 2

• what is a Freva wrapper? Main components
• how to connect a tool to Freva
• Freva databrowser restAPI for non-python languages
• how to install all needed libraries of a tool
• the link2fordata utility
• how to plug a plugin to Freva
• extra: calling a plugin within a plugin with git submodules

Q&A

7. Hands-on 2: playing with a plugin

13/06/2024, 12:45

Day 2

Interactive example with the previously cloned plugin:
• looking at the diff components
• testing how to connect via cli, web, python
• modifying, debugging

Q&A

11. Closing remarks

13/06/2024, 14:45

Day 2

Back to the event