| Both sides previous revision Previous revision Next revision | Previous revision |
| freva_plugin_workshop_2021.04.15 [2021/04/13 10:21] – [Material that will be used / shown in the worksho] etorma | freva_plugin_workshop_2021.04.15 [2021/11/11 14:05] (current) – [Material that will be used / shown in the workshop] etorma |
|---|
| ======= Material that will be used / shown in the worksho ======= | ======= Material that will be used / shown in the workshop ======= |
| |
| |
| In [[https://gitlab.dkrz.de/freva/plugins4freva/plugin_workshop|our workshop's gitlab repository]] we have placed some projects: | In [[https://gitlab.dkrz.de/freva/plugins4freva/plugin_workshop|our workshop's gitlab repository]] we have placed some projects: |
| - a plugin called ''wetdry'': it will be used as a showcase in the hands-on. It's a functional plugin straight away. It has a ''docs/'' folder with jupyternotebook files where each part of the plugin is commented almost line-by-line. It will be run by the users. | - a plugin called ''wetdry'': it will be used as a showcase in the hands-on. It's a functional plugin straight away. It has a ''docs/'' folder with jupyternotebook files where each part of the plugin is commented almost line-by-line. It will be run by the users. The repository is [[https://gitlab.dkrz.de/freva/plugins4freva/plugin_workshop/wetdry|this one]]. |
| - a plugin called ''wetdry_debug'': a modified version of the previous one. Is incomplete, it has some bugs. It will be used to explore it by the users, test it and run it. | - a plugin called ''wetdry_debug'': a modified version of the previous one. Is incomplete, it has some bugs. It will be used to explore it by the users, test it and run it. The repository [[https://gitlab.dkrz.de/freva/plugins4freva/plugin_workshop/wetdry_debug|is this one]]. |
| - a plugin called ''wetdry_plus'': a more complex version of the ''wetdry'' plugin with added capabilities. It will not be shown | - a plugin called ''wetdry_plus'': a more complex version of the ''wetdry'' plugin with added capabilities, like input from databrowser and incall to other freva plugins. It will not be shown. The repository is [[https://gitlab.dkrz.de/freva/plugins4freva/plugin_workshop/wetdry_plus|this one]]. |
| |
| In order to follow the hands-on you will need to download them and place them somewhere where the //evaluation system// (i.e. XCES) will be able to //see// them. | In order to follow the hands-on you will need to download them and place them somewhere where the //evaluation system// (i.e. XCES) will be able to //see// them. |
| | |
| | |
| | To look and execute the code we can do it [[login_shell|via the shell terminal]] or via [[connec2jupyterhub|DKRZ's jupyterhub]]. |
| |
| ====== Steps for downloading the plugins ====== | ====== Steps for downloading the plugins ====== |
| |
| |
| Currently, we will use the most straightforward way, i.e., via **https**, for that we only need to copy the address (e.g.) https://gitlab.dkrz.de/freva/plugins4freva/plugin_workshop/wetdry.git and (in your newly created folder) follow the instructions entering your username and password: | Currently, we will use the most straightforward way, i.e., via **https**, for that we only need to copy the address (e.g. [[https://gitlab.dkrz.de/freva/plugins4freva/plugin_workshop/wetdry.git|wetdry]]) and (in your newly created folder) follow the instructions entering your username and password: |
| |
| <code bash> | <code bash> |
| 3 directories, 7 files | 3 directories, 7 files |
| </code> | </code> |
| | |
| | \\ \\ |
| | **For the workshop we will need to do this 2 times, for ''wetdry'' and ''wetdry_debug''** so we finally have something like: |
| | |
| | <code bash> |
| | $ cd /path/to/your/plugin/folder/ |
| | $ ls |
| | wetdry/ wetdry_debug/ |
| | </code> |
| | |
| | \\ \\ |
| | We left the ''wetdry_plus'' so the users can navigate and compare it with ''wetdry''. We also encourage you to explore it and run it. |
| | |
| | \\ |
| | \\ |
| | \\ |
| | ===== Additional material of the workshop ===== |
| | |
| | ===Theory (1st Block)=== |
| | \\ |
| | PPT material for the plugin part: {{:climxtreme:plugin_presentation.pptx}}. It has additional information on how to clone a repository via SSH and how to create a project (these will eventually also be added in the wikipage).\\ |
| | \\ |
| | {{climxtreme:climxtreme_-_plugin_workshop_2021-04-15_01.mp4}}\\ |
| | \\ |
| | ===Hands-on (2nd Block)=== |
| | \\ |
| | PPT material of the plugin architecture: {{:climxtreme:plugin_hands-on.pptx}}\\ |
| | \\ |
| | {{climxtreme:climxtreme_-_plugin_workshop_2021-04-15_02.mp4}}\\ |