From 5ca609beecbed0282ac4e029990fe67a8dbaf6f3 Mon Sep 17 00:00:00 2001 From: Jusong Yu Date: Tue, 10 Oct 2023 10:30:07 +0200 Subject: [PATCH] Docs: Update the image name for docker image (#6143) It was still pointing to the old name instead of the new `aiida-core-with-services`. --- docs/source/intro/run_docker.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/source/intro/run_docker.rst b/docs/source/intro/run_docker.rst index 669dffae6c..70c4720132 100644 --- a/docs/source/intro/run_docker.rst +++ b/docs/source/intro/run_docker.rst @@ -5,12 +5,12 @@ Run AiiDA via a Docker image **************************** -The AiiDA team maintains a `Docker `__ image on `Docker Hub `__. +The AiiDA team maintains a `Docker `__ image on `Docker Hub `__. This image contains a fully pre-configured AiiDA environment which makes it particularly useful for learning and testing purposes. .. caution:: - All data stored in a container will persist only over the lifetime of that particular container unless you use volumes (see instructions below). + All data stored in a container will persist only over the lifetime of that particular container (i.e., removing the container will also purge the data) unless you use volumes (see instructions below). .. grid:: 1 :gutter: 3 @@ -19,29 +19,19 @@ This image contains a fully pre-configured AiiDA environment which makes it part To install Docker, please refer to the `official documentation `__. - .. note:: - - If you are using Linux, you need to have root privileges to do `post-installation steps for the Docker Engine `__. - .. grid-item-card:: Start container and use AiiDA interactively - First, pull the image: - - .. parsed-literal:: - - $ docker pull aiidateam/aiida-core:latest - - Then start the container with: + Start the container with (replace ``latest`` with the version you want to use, check the `Docker Hub `__ for available tags/versions): .. parsed-literal:: - $ docker run -it aiidateam/aiida-core:latest bash + $ docker run -it aiidateam/aiida-core-with-services:latest bash You can specify a name for the container with the ``--name`` option for easier reference later on: .. parsed-literal:: - $ docker run -it --name aiida-container aiidateam/aiida-core:latest bash + $ docker run -it --name aiida-container aiidateam/aiida-core-with-services:latest bash .. grid-item-card:: Check setup @@ -59,6 +49,16 @@ This image contains a fully pre-configured AiiDA environment which makes it part ✓ rabbitmq: Connected as amqp://127.0.0.1?heartbeat=600 ✓ daemon: Daemon is running as PID 1795 since 2020-05-20 02:54:00 + .. grid-item-card:: Copy files from your computer to the container + + To copy files from your computer to the container, use the ``docker cp`` command. + + For example, to copy a file named ``test.txt`` from your current working directory to the ``/home/aiida`` path in the container, run: + + .. code-block:: console + + $ docker cp test.txt aiida-container:/home/aiida + .. grid-item-card:: Persist data across different containers If you stop the container (`docker stop` or simply `Ctrl+D` from container) and start it again, any data you created will persist.