docs: add information for python on how to plug a plugin and how to freshly load a freva config #238
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…reshly load a freva config
antarcticrainforest
requested changes
Oct 31, 2024
There was a problem hiding this comment.
Check #239 which makes the workarounds mentioned here depricated.
Comment on lines
+385
to
+400
| .. note:: | ||
| You cannot freshly set a configuration via ``freva.config("/work/freva/evaluation_system.conf")`` | ||
| if there was no previous ones. For that you will need to: | ||
|
|
||
| :: | ||
|
|
||
| # 1. Set up the environment variables: | ||
| import os | ||
| os.environ["EVALUATION_SYSTEM_CONFIG_FILE"]="/work/freva/evaluation_system.conf" | ||
| os.environ["EVALUATION_SYSTEM_CONFIG_DIR"]="/work/freva" | ||
| # 2. load Freva library: | ||
| import freva | ||
|
|
||
| Then, you can use :py:class:`freva.config` to switch to a new configuration. | ||
|
|
||
|
|
There was a problem hiding this comment.
This should be fixed with #239.
Comment on lines
+175
to
+185
| .. note:: | ||
| In python (e.g. jupyter notebook) you will need first to add your plugin(s) as | ||
| an entry in the ``EVALUATION_SYSTEM_PLUGINS`` environment variable and *then* | ||
| import the Freva module (not the other way around):: | ||
|
|
||
| import os | ||
| os.environ["EVALUATION_SYSTEM_PLUGINS"] = "/path1,plugin1:/path2,plugin2:/path3,plugin3" | ||
|
|
||
| import freva | ||
| freva.get_tools_list() | ||
|
|
There was a problem hiding this comment.
Should be fixed with #239. If you want you can mention the freva.config(plugin_path="...") option.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I realised that different users have been asking these questions so I documented how to do it (unless we update the code, see issues #233, #235 that I was unable to solve).
Still I have the feeling that the information on how to load freva is pretty much scattered around in the docu, if you agree, once merged I will summarize the different ways to connect to freva + a very short introduction to freva-client in the DKRZ documentation so if anyone asks we can refer them to the DKRZ page.