Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What is 'configuration namespace' #160

Open
SHuang-Broad opened this issue Jul 19, 2021 · 2 comments
Open

What is 'configuration namespace' #160

SHuang-Broad opened this issue Jul 19, 2021 · 2 comments

Comments

@SHuang-Broad
Copy link

Hi,

We are learning how to make use of FISS, and are reading the outputs from help(fapi).
I have a conceptual question: What is 'configuration namespace'?
This question came up while reading the doc for get_workspace_config.

And more specifically, under the assumption that the workspace lives in Terra, would it always be the same as namespace, or practically most of the time?

Thank you!
Steve from Methods group, DSP

@dheiman
Copy link
Collaborator

dheiman commented Jul 20, 2021

fiss/firecloud/api.py (often imported as fapi) is a python wrapper for the Terra API. get_workspace_config in particular is a wrapper for https://api.firecloud.org/#!/Method_Configurations/getWorkspaceMethodConfig.

If you want a definitive answer for what a "configuration namespace" is, then you will want to ask the team that maintains firecloud-orchestration.

As a fellow user, I can tell you that when you import a workflow into a workspace, you are given the option to set the namespace for its configuration, with the default being the namespace it comes from (at least in Broad Methods Repository/agora, I don't have as much experience with Dockstore). This is the namespace being referred to.

So the answer to your second question is: not in my experience, configuration namespace is a completely separate concept from workspace namespace.

On a separate note, api.py is a low-level wrapper. For enhanced features found in the command-line tool see fiss.py, which should be installed to fissfc.

@SHuang-Broad
Copy link
Author

Thanks David!
It's much clearer now.
We do tend to import workflows into workspaces (that we have some control of) from Dockstore, which doesn't seem to have that option when importing.

Regarding api.py vs fiss.py, am I understanding this correctly, that it's preferable to use the latter? We've been studying the former, but are happy to follow the suggested practices.

Thanks!
Steve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants