From b86e29702d2b210cdc0569bad060b320ebabbf22 Mon Sep 17 00:00:00 2001 From: David Minton Date: Thu, 29 Feb 2024 19:09:19 -0500 Subject: [PATCH] Removed the Docker instructions until they can be cleaned up --- docs/getting-started-guide/index.rst | 74 +--------------------------- 1 file changed, 1 insertion(+), 73 deletions(-) diff --git a/docs/getting-started-guide/index.rst b/docs/getting-started-guide/index.rst index 514b5ffdb..790e0d231 100644 --- a/docs/getting-started-guide/index.rst +++ b/docs/getting-started-guide/index.rst @@ -203,79 +203,7 @@ You may need to run the above command as root or with sudo if you are installing Building the exectuable using Docker ------------------------------------ -The Swiftest project contains a Dockerfile -that may be used to generate an executable without needing to provide -any external dependencies, other than the Docker engine itself (see -`here `__ for instructions on -obtaining Docker). Once Docker is installed and the Docker engine is -running, execute:: - - $ docker build --target=export-driver \ - --output=./bin \ - --build-arg MACHINE_CODE_VALUE="Host" \ - [ -f Dockerfile.GNU-Linux | -f Dockerfile.Intel ] \ - [ --build-arg BUILD_TYPE="*RELEASE*|DEBUG|TESTING|PROFILE" ] \ - [ --build-arg EXTRA_CMAKE_OPTIONS="-D" ] . - -The Docker build will download and compile all of the library -dependencies (HDF5, NetCDF-C, and NetCDF-Fortran) as static libraries -and the Swiftest driver using Intel compilers. Once completed, the -Swiftest executable, called ``swiftest_driver``, should now be created -in the ``bin/`` directory. - - Note: The Dockerfile is designed to build an executable that is - compatible with a broad range of CPU architectures by specifying the - SSE2 instruction as a target for SIMD instructions using the ``-x`` - compiler option. When compiling on the same CPU archictecture you - plan to execute the driver program, for the highest possible SIMD - performance, use - ``--build-arg MACHINE_CODE_VALUE="Host"`` to override the default ``MACHINE_CODE_VALUE=“SSE2”``. - For additional options see - `here `__. - -The optional Docker argument ``EXTRA_CMAKE_OPTIONS`` is provided to pass any additional CMake arguments (see `supported CMake options `_) - - -Download the executable as a Docker or Singularity container. -------------------------------------------------------------- - -The Swiftest driver is available as a Docker container on DockerHub in -two versions: Intel and GNU. The Intel version was compiled for the -x86_64 CPU using the Intel classic Fortran compiler. The GNU version was -compliled for the x86_64 CPU using gfortran. The Intel version is faster -than the GNU version (though not as fast as a native compile to the -target CPU that you wish to run it on due to vectorization optimizations -that Swiftest takes advantage of), however it is much larger: The Intel -version is ~2.7GB while the GNU version is ~300MB. The Singularity -container pulls from the same DockerHub container. - -To facilitate installation of the container, we provide a set of shell -scripts to help automate the process of installing container versions of -the executable. To install the default Intel version of the docker -container from within the ``swiftest\`` project directory:: - - $ cd docker - $ . ./install.sh - -To install the GNU version:: - - $ cd docker - $ . ./install.sh gnu - -The Singularity versions are installed the same way, just replace -``cd docker`` with ``cd singularity`` above. - -Whether installing either the Docker or Singularity containers, the -install script will copy an executable shell script ``swiftest_driver`` -into ``swiftest/bin/``. Not that when installing the Singularity -container, the install script will set an environment variable called -``SWIFTEST_SIF`` that must point to the aboslute path of the container -file called ``swiftest_driver.sif``. To use the driver script in a -future shell, rather than running the install script again, we suggest -adding the environment variable definition to your shell startup script -(e.g. add -``export SWIFTEST_SIF="/path/to/swiftest/singularity/swiftest.sif"`` to -your ``.zshrc``) +TBD