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

improved doc in galaxy.ini for outputs_to_working_directory #5332

Conversation

bernt-matthias
Copy link
Contributor

to avoid misconfigurations as in #5323

furthermore I reordered the description such that first the option is described and then the use case

Copy link
Member

@mvdbeek mvdbeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes.
Could you get rid of the extra merge commits ?
Assuming origin is the galaxy remote something like git checkout origin/dev && git checkout -b my_new_feature && git cherry-pick 1648e352cba4edafb44f767649a0da7bc916e5d2 should work

# This option will override tool output paths to write outputs to the working
# directory (instead of to the file_path) and the job manager will move the
# outputs to their proper place in the dataset directory on the Galaxy server
# after the job completes. This is necessary (for example) you run on a cluster
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/is necessary (for example) you/is necessary (for example) if jobs/

# outputs to their proper place in the dataset directory on the Galaxy server
# after the job completes. This is necessary (for example) you run on a cluster
# and your datasets (file_path) can not be written by the user running the jobs
# (e.g. if the filesystem is mounted read-only or the jobs are run by a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a a extra whitespace here.

# directory (instead of to the file_path) and the job manager will move the
# outputs to their proper place in the dataset directory on the Galaxy server
# after the job completes. This is necessary (for example) you run on a cluster
# and your datasets (file_path) can not be written by the user running the jobs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/and your datasets (file_path) can not be written/and datasets are not writable/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say: "and the output datasets cannot be created inside file_path by the user running the jobs"

# paths to write outputs to the working directory instead, and the job manager
# will move the outputs to their proper place in the dataset directory on the
# Galaxy server after the job completes.
# This option will override tool output paths to write outputs to the working
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/the working/the job working/

@@ -1333,7 +1335,7 @@ use_interactive = True
# actual user instead of as the user running the Galaxy server process. For
# details on these options, see the documentation at:
#
# https://galaxyproject.org/admin/config/performance/cluster
# https://galaxyproject.org/admin/config/performance/cluster#configuration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@galaxybot galaxybot added this to the 18.01 milestone Jan 18, 2018
@@ -1333,7 +1335,7 @@ use_interactive = True
# actual user instead of as the user running the Galaxy server process. For
# details on these options, see the documentation at:
#
# https://galaxyproject.org/admin/config/performance/cluster
# https://galaxyproject.org/admin/config/performance/cluster#submitting-jobs-as-the-real-user
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of the redirect the anchor will not work, please use: https://docs.galaxyproject.org/en/latest/admin/cluster.html#submitting-jobs-as-the-real-user

@martenson
Copy link
Member

galaxy.ini.sample is gone - I ported these changes to new config in the PR linked above, thanks @bernt-matthias !

@martenson martenson closed this Jan 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants