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.

Sign up for GitHub

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

Slimmer code blocks in Docker usage docs #1102

Merged
merged 1 commit into from
Oct 8, 2024
Merged

Slimmer code blocks in Docker usage docs #1102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/user_guide/docker_demo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,11 @@ It relies on some of the GIN data from the main testing suite, see :ref:`example

.. code::

docker run -t --volume /home/user/demo_neuroconv_docker:/demo_neuroconv_docker ghcr.io/catalystneuro/neuroconv:latest neuroconv /demo_neuroconv_docker/demo_neuroconv_docker_yaml.yml --output-folder-path /demo_neuroconv_docker/demo_output
docker run -t \
--volume /home/user/demo_neuroconv_docker:/demo_neuroconv_docker \
ghcr.io/catalystneuro/neuroconv:latest \
neuroconv /demo_neuroconv_docker/demo_neuroconv_docker_yaml.yml \
--output-folder-path /demo_neuroconv_docker/demo_output

Voilà! If everything occurred successfully, you should see...

Expand Down Expand Up @@ -142,6 +146,10 @@ Then, you can use the following command to run the Rclone Docker image:

.. code::

docker run -t --volume destination_folder:destination_folder -e RCLONE_CONFIG="$RCLONE_CONFIG" -e RCLONE_COMMAND="$RCLONE_COMMAND" ghcr.io/catalystneuro/rclone_with_config:latest
docker run -t \
--volume destination_folder:destination_folder \
-e RCLONE_CONFIG="$RCLONE_CONFIG" \
-e RCLONE_COMMAND="$RCLONE_COMMAND" \
ghcr.io/catalystneuro/rclone_with_config:latest

This image is particularly designed for convenience with AWS Batch (EC2) tools that rely heavily on atomic Docker operations. Alternative AWS approaches would have relied on transferring the Rclone configuration file to the EC2 instances using separate transfer protocols or dependent steps, both of which add complexity to the workflow.
Loading