Differences

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

--- basic_users_guide_xces_new [2024/01/03 13:53] – [Access through python module (pypi, jupyter)] etorma
+++ basic_users_guide_xces_new [2025/02/12 09:42] (current) – [Creating your own conda/mamba environment with the freva library] etorma
@@ Line 69: / Line 69: @@
 If that is the case, in the website you should be able to see the following when trying to ''Plug-my-plugin'' button at the [[https://www.xces.dkrz.de/plugins/|Plugins section]]:
-{{:climxtreme:plug_my_plugin_new.png?nolink|}}
+{{:public:plug_my_plugin_new.png?nolink|}}
 \\
@@ Line 179: / Line 179: @@
 Then, in your own jupyterhub session when launching a new e.g. Notebook you will see that kernel ready to be used:
-{{ :climxtreme:jupyter_kernels.jpg?nolink|}}
+{{ :public:jupyter_kernels.jpg?nolink&800 |}}
-//
+Incidentaly, you can also install a jupyter kernel based on freva's R environment like this:
-If, on the other hand you want to use freva as a python library alongside others (e.g. in a conda environment) then you can:
+<code bash>
-  - install the package via pypi ''pip install freva''
+% ssh <username>@levante.dkrz.de
+$ module load clint xces
+$ jupyter-kernel-install r --name xces-r --display-name XCES-R
+</code>
+BUT be aware that there is currently NO API to call freva functionalities within R, so it will only work as an additional R kernel, nothing more.
+===== Creating your own conda/mamba environment with the freva library =====
+If you want to use freva as a python library alongside others (e.g. in a conda environment) then you can:
+  - install the package via pypi ''pip install freva'' or via conda/mamba ''mamba install -c conda-forge freva''
   - add the environment config of XCES in your script, e.g.:
 <code python>
@@ Line 191: / Line 200: @@
 import freva
 </code>
+<WRAP round important>
+**NOTE**: since 2024 DKRZ does not allow access to ''default'' channels in conda [[https://legal.anaconda.com/policies/en/#terms-of-service| due to changes in Anaconda's terms of services]]. You need to make sure you will not use it or you will get an ''HTTP error'' message while trying to create an env. Options:
+  * use flag '' --override-channels'' so it does not search default.
+  * create ''$HOME/.condarc'' file with:
+<code>
+channels:
+  - conda-forge
+</code>
+  * (similar to 2):
+<code>
+# check what is currently set
+conda config --show channels
+# remove what you find
+conda config --remove channels defaults
+# add conda-forge
+conda config --add channels conda-forge
+</code>
+</WRAP>
 ===== Using XCES/Freva R/Python environment to locally install your own packages =====
+<WRAP round info>
+Not recommended! Your libraries would depend on the current Freva python/R environment that will eventually be updated and, hence, get obsolete.
+</WRAP>
 xces/Freva ships with its own R and Python environment, with some basic set of libraries included already. These environments can be used out-of-the-box. To check the R/Python version please:
@@ Line 234: / Line 269: @@
 </code>
-The package will then be downloaded, built, including dependencies, and installed under ''$HOME/.local''.
+The package will then be downloaded, built, including dependencies, and installed under ''$HOME/.local/lib/python3.X/site-packages''.
+**NOTE**: conda/mamba does not allow to do something similar to that, so if the package you want to append can only be installed via conda then you will need to create your own environment.
 ==== 2. Installing R packages locally ====