From 32c18f80f4130e89381e17158812e9341d4ac49a Mon Sep 17 00:00:00 2001 From: Cody Baker <51133164+CodyCBakerPhD@users.noreply.github.com> Date: Thu, 21 Mar 2024 18:09:14 -0400 Subject: [PATCH] update dev docs --- docs/developer_guide/docker_images.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/developer_guide/docker_images.rst b/docs/developer_guide/docker_images.rst index 018a1c272..d78b3cfd0 100644 --- a/docs/developer_guide/docker_images.rst +++ b/docs/developer_guide/docker_images.rst @@ -69,7 +69,7 @@ and can then run the entrypoint (equivalent to the usual command line usage) on .. code:: - docker run -it --volume /your/local/drive/:/desired/alias/of/drive/ ghcr.io/catalystneuro/neuroconv:latest neuroconv /desired/alias/of/drive/your_specification_file.yml + docker run -it --volume /your/local/volume/:/desired/alias/of/volume/ ghcr.io/catalystneuro/neuroconv:latest neuroconv /desired/alias/of/drive/your_specification_file.yml @@ -82,13 +82,15 @@ The only potential downside with this usage is the maximum size of an environmen Otherwise, in any cloud deployment, the YAML file transfer will have to be managed separately, likely as a part of the data transfer or an entirely separate step. -To use this alternative image on a local environment, you no longer need to invoke the ``neuroconv`` entrypoint pointing to a file. Instead, just set the environment variable and run the docker container on the mounted volume... +To use this alternative image on a local environment, you no longer need to invoke the ``neuroconv`` entrypoint pointing to a file. Instead, just set the environment variables and run the docker container on the mounted volume... .. code:: - export YAML_STREAM="" # On Windows, use `set` instead of `export` - docker run -it --volume /your/local/drive/:/desired/alias/of/drive/ ghcr.io/catalystneuro/neuroconv:yaml_variable + export YAML_STREAM="" + export NEUROCONV_DATA_PATH="/desired/alias/of/volume/" + export NEUROCONV_OUTPUT_PATH="/desired/alias/of/volume/" + docker run -it --volume /your/local/volume/:/desired/alias/of/volume/ ghcr.io/catalystneuro/neuroconv:yaml_variable .. note:: - When using YAML files through the docker containers, always be sure that the file and folder paths are absolute stemming from the base volume as mounted inside the container; otherwise, the NWB file will be written inside pf the container but will then not be accessible outside of it. + On Windows, use ``set`` instead of ``export``.