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

Update the snakemake pipeline to run tierpsy tracker and begin documentation of pipeline in README #6

Merged
merged 17 commits into from
Sep 20, 2024

Conversation

taylorreiter
Copy link
Member

PR checklist

  • Tag the issue(s) or milestones this PR fixes (e.g. Fixes #123, Resolves #456).
  • Describe the changes you've made.
  • Describe any tests you have conducted to confirm that your changes behave as expected.
  • If you've added new software dependencies, make sure that those dependencies are included in the appropriate conda environments.
  • If you've added new functionality, make sure that the documentation is updated accordingly.
  • If you encountered bugs or features that you won't address, but should be addressed eventually, create new issues for them.

Issues

Description

This PR adds a rule to run Tierpsy tracker to the snakefile. It includes instructions/documentation for Docker. I'm fully aware that this is a sub-par solution, but I think it's good enough for now.

I also started documented the pipeline in the README. I'll add more in future PRs.

Copy link
Member

@keithchev keithchev left a comment

Choose a reason for hiding this comment

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

Looks good! Just a bunch of minor comments/suggested edis.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Snakefile Show resolved Hide resolved
Comment on lines +117 to +124
-e SHELL=/bin/bash \
-e HOME=/home/tierpsy_user \
-e PATH=/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/tierpsy_user/.local/bin \
-e TERM=xterm \
-e PWD=/DATA \
-e SHLVL=1 \
-e LIBGL_ALWAYS_INDIRECT=1 \
-e DOCKER_HOME=/home/tierpsy_user \
Copy link
Member

Choose a reason for hiding this comment

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

Is it possible to set some of these env vars in the dockerfile instead? That would de-clutter the snakefile a bit (and clarify which env vars don't need to be specific to this docker exec command).

Copy link
Member Author

@taylorreiter taylorreiter Sep 20, 2024

Choose a reason for hiding this comment

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

I do not know how to do that, so I'll open an issue for this as well!

Edit: see #11

docker/Dockerfile Show resolved Hide resolved
scripts/tierpsy_linux_no_gui_background.sh Outdated Show resolved Hide resolved
scripts/tierpsy_linux_no_gui_background.sh Outdated Show resolved Hide resolved
@taylorreiter taylorreiter merged commit eb92101 into main Sep 20, 2024
2 checks passed
@taylorreiter taylorreiter deleted the ter/pipeline-updates branch September 20, 2024 13:53
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

Successfully merging this pull request may close these issues.

2 participants