Differences

This shows you the differences between two versions of the page.

--- basic_users_guide_xces_new [2025/05/16 12:20] – etorma
+++ basic_users_guide_xces_new [2025/05/19 11:50] (current) – [Installing the freva library] etorma
@@ Line 1: / Line 1: @@
 ===== Getting familiar with the XCES Platform ======
+<WRAP round info>
+  * For a **quick tour** through Freva and Freva Plugins please [[https://freva-clint.github.io/Talks/Freva_Workshop_2024/index.slides.html|take a look here]].
+  * You also have some **hands-on exercises** to get yourself familiarised with freva and plugins [[https://gitlab.dkrz.de/freva/freva_workshop|here]].
+</WRAP>
 The XCES platform is an instance of the Free Evaluation System Framework (Freva), designed by the Freva team and adapted for the scientists of the ClimXtreme project by Module D. Below you will find relevant information on how to get started with the system.
-The system can used either through the [[basic_users_guide_xces_new#Access through the shell|shell]], [[basic_users_guide_xces_new#Access through the web|website]], or [[basic_users_guide_xces_new#access_through_python_module_pypi_jupyter|its python module (e.g. for Jupyter)]]. We will give an overview of the capabilities of XCES on all platforms and also the necessary steps to set a working environment in the shell that will allow us [[https://freva-clint.github.io/freva/FrevaCli.html#add-new-data-to-the-databrowser|to share data]] with the rest of the ClimXtreme community or test our [[list_of_plugins|plugins]] in development stage.
+The system can used either through the [[basic_users_guide_xces_new#Access through the shell|shell]], [[basic_users_guide_xces_new#Access through the web|website]], or [[basic_users_guide_xces_new#access_through_python_module_pypi_jupyter|its python module (e.g. for Jupyter)]]. We will give an overview of the capabilities of XCES on all platforms and also the necessary steps to set a working environment in the shell that will allow us [[https://freva-clint.github.io/freva/FrevaCli.html#add-new-data-to-the-databrowser|to share data]] with the rest of the ClimXtreme community or test our [[https://gitlab.dkrz.de/bm1159/plugins4freva/gitlab-profile/-/blob/main/README.md|plugins]] in development stage.
@@ Line 238: / Line 244: @@
+==== Creating a jupyter kernel out of your environment ====
+For that, you will need to previously install the ''ipykernel'' library via e.g.:
+<code python>
+conda create --name myenv python=3.8 ipykernel # with conda
+python -m pip install ipykernel # with pip
+</code>
+And then, given you are using the python binary of your environment:
+<code python>
+python -m ipykernel install --user --name=$(KERNEL_NAME) --display-name $(KERNEL_NAME)
+</code>
 ==== Installing the freva library ====
@@ Line 246: / Line 267: @@
   - add the environment config of XCES in your script, e.g.:
 <code python>
-import os,sys
-os.environ["EVALUATION_SYSTEM_CONFIG_FILE"] = "/work/bm1159/XCES/freva/evaluation_system.conf" # this is for the environment
-os.environ["EVALUATION_SYSTEM_CONFIG_DIR"] = "/work/bm1159/XCES/freva" # this is for the environment
 import freva
+freva.config(config_file="/work/bm1159/XCES/freva/evaluation_system.conf")
 </code>
+that should work on a python script, python env console and jupyter notebook (e.g. [[https://jupyterhub.dkrz.de|DKRZ's jupyterhub]].
+Incidentally, you can load plugins using the same command, e.g.:
+<code python>
+import freva
+freva.config(config_file="/path/to/the/freva/config/file.conf",
+             plugin_path="~/freva/mypluing,the_plugin")
+</code>