Skip to content

Commit

Permalink
Slimmer code blocks in Docker usage docs (#1102)
Browse files Browse the repository at this point in the history
  • Loading branch information
CodyCBakerPhD authored Oct 8, 2024
1 parent 0cc66de commit ccc4a1e
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/user_guide/docker_demo.rst
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.

0 comments on commit ccc4a1e

Please sign in to comment.