From ce22b1905c2c372dc9181a18f08656d5c0ea068c Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Mon, 8 Mar 2021 07:00:32 -0600 Subject: [PATCH] Add Docker instructions to regular installation section --- docs/source/quickinstall.rst | 14 +++++++++----- docs/source/usersguide/install.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 5 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index c996ecf29..f0acf3593 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -47,18 +47,22 @@ Installing on Linux/Mac/Windows with Docker ------------------------------------------- OpenMC can be easily deployed using `Docker `_ on any -Windows, Mac or Linux system. With Docker running, execute the following -command in the shell to download and run a `Docker image`_ with the most recent release of OpenMC from `DockerHub `_ called ``openmc/openmc:v0.10.0``: +Windows, Mac, or Linux system. With Docker running, execute the following command +in the shell to download and run a `Docker image`_ with the most recent release +of OpenMC from `DockerHub `_ called +``openmc/openmc:v0.10.0``: .. code-block:: sh docker run openmc/openmc:v0.10.0 -This will take several minutes to run depending on your internet download speed. The command will place you in an interactive shell running in a `Docker container`_ with OpenMC installed. +This will take several minutes to run depending on your internet download speed. +The command will place you in an interactive shell running in a `Docker +container`_ with OpenMC installed. .. note:: The ``docker run`` command supports many `options`_ for spawning - containers -- including `mounting volumes`_ from the host - filesystem -- which many users will find useful. + containers including `mounting volumes`_ from the host filesystem, + which many users will find useful. .. _Docker image: https://docs.docker.com/engine/reference/commandline/images/ .. _Docker container: https://www.docker.com/resources/what-container diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 46a427aed..d5c64d842 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -42,6 +42,33 @@ the environment, run: conda activate openmc-env +------------------------------------------- +Installing on Linux/Mac/Windows with Docker +------------------------------------------- + +OpenMC can be easily deployed using `Docker `_ on any +Windows, Mac, or Linux system. With Docker running, execute the following +command in the shell to download and run a `Docker image`_ with the most recent +release of OpenMC from `DockerHub `_ called +``openmc/openmc:v0.10.0``: + +.. code-block:: sh + + docker run openmc/openmc:v0.10.0 + +This will take several minutes to run depending on your internet download speed. +The command will place you in an interactive shell running in a `Docker +container`_ with OpenMC installed. + +.. note:: The ``docker run`` command supports many `options`_ for spawning + containers including `mounting volumes`_ from the host filesystem, + which many users will find useful. + +.. _Docker image: https://docs.docker.com/engine/reference/commandline/images/ +.. _Docker container: https://www.docker.com/resources/what-container +.. _options: https://docs.docker.com/engine/reference/commandline/run/ +.. _mounting volumes: https://docs.docker.com/storage/volumes/ + .. _install-spack: ---------------------------------- @@ -128,6 +155,7 @@ feature can be used to access the installed packages. .. _Spack: https://spack.readthedocs.io/en/latest/ .. _setup guide: https://spack.readthedocs.io/en/latest/getting_started.html + .. _install_source: ----------------------