Update Dockerfile to build ModEM with CMake and change CMake output directory (#43)

This Commit updates the Dockerfile so that it builds each of the ModEM forward
formulations using CMake. This will help to test both the configure build chain
and the new ModEM build chain.

In the Dockerfile, it runs the cmake build in `/home/modem/modem-build`.

This commit also updates the CMake ModEM build so that the exectuables no
longer are generated in the `$CMAKE_BINARY_DIR/f90/` directory and are instead
just in the top level `$CMAKE_BINARY_DIR` directory.

Author: MiCurry

CMakeLists.txt

@@ -25,6 +25,8 @@ set(SUPPORTED_FORWARD_FORMULATIONS "MF;SP;SP2")
 set(SUPPORTED_MODEM_DIMS "2D;3D")
 set(SUPPORTED_GPU_OPTS "off;OFF;CUDA;HIP")
 
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}")
+
 if (USE_C_TIMERS)
         enable_language(C)
 endif()

Dockerfile

@@ -9,14 +9,21 @@ RUN apt-get -y install valgrind
 RUN apt-get -y install libblas-dev
 RUN apt-get -y install liblapack-dev
 RUN apt-get -y install make
+RUN apt-get -y install cmake
 RUN apt-get -y install wget
 RUN apt-get -y install python3
 RUN apt-get -y install python3-pip
 RUN apt-get -y install pipx
 RUN apt-get -y install vim
 RUN apt-get -y install git
 RUN apt-get -y install openmpi-bin openmpi-common libopenmpi-dev
+
+# Create a ModEM user and give them sudo access
+# so it's easier for people to install things
+RUN apt-get -y install sudo
 RUN useradd -m -r -g users -s /bin/bash modem
+RUN adduser modem sudo
+RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
 
 ENV LD_LIBRARY_PATH=/usr/local/lib/
 # For Python Installs
@@ -29,9 +36,16 @@ RUN chgrp -R users /home/modem/ModEM
 USER modem
 WORKDIR /home/modem/ModEM/f90
 
-# Make SP2 MPI
+# Make MF, SP and SP2 using Configure
 RUN ./CONFIG/configure -m mpi -l MF -g release Makefile gfortran && make && mv Mod3DMT Mod3DMT_MF && make clean
 RUN ./CONFIG/configure -m mpi -l SP -g release Makefile gfortran && make && mv Mod3DMT Mod3DMT_SP && make clean
 RUN ./CONFIG/configure -m mpi -l SP2 -g release Makefile gfortran && make && mv Mod3DMT Mod3DMT_SP2 && make clean
 
-WORKDIR /home/modem/
+# Make MF, SP and SP2 Using CMake
+RUN mkdir -p /home/modem/modem-build
+WORKDIR /home/modem/modem-build
+RUN cmake ~/ModEM -DCMAKE_Fortran_COMPILER=mpifort -DCMAKE_C_COMPILER=mpicc -DFORWARD_FORMULATION=MF && make
+RUN cmake ~/ModEM -DCMAKE_Fortran_COMPILER=mpifort -DCMAKE_C_COMPILER=mpicc -DFORWARD_FORMULATION=SP && make
+RUN cmake ~/ModEM -DCMAKE_Fortran_COMPILER=mpifort -DCMAKE_C_COMPILER=mpicc -DFORWARD_FORMULATION=SP2 && make
+
+WORKDIR /home/modem/

docs/source/building_with_cmake.rst

@@ -164,15 +164,17 @@ written successfully, you'll be able to call ``make`` and build ModEM:
     [100%] Linking Fortran executable Mod3DMT
     [100%] Built target Mod3DMT
 
-The ``Mod3DMT`` will then be placed in the f90 file inside your build directory,
-which you will be able to run as normal.
+The ModEM executables will be placed in the root of your build directory. They
+are appended with the name of the forward formulation use: ``Mod3DMT_MF,
+Mod3DMT_SP, Mod3DMT_SP2``. By default, the CMake build will build
+``Mod3DMT_SP2``.
 
 
 Options - Different configurations
 ----------------------------------
 
-You can build different ModEM configurations by specifying different options when calling
-``cmake``:
+You can build different ModEM configurations by specifying different options
+when calling ``cmake``:
 
 Again, once can use the following to display all the available options:
 
@@ -205,7 +207,8 @@ You can specify them on the command line by doing the following during the ``cma
 
 .. warning::
 
-    The ModEM CMake build can only build the 3D version of ModEM and cannot build the 2D version.
+    The ModEM CMake build can only build the 3D version of ModEM and cannot
+    build the 2D version at this time.
 
 .. _findlapack_n_blas:
 

docs/source/getting_started.rst

@@ -353,7 +353,7 @@ Normally, when running a docker container, the data created inside the container
 will be deleted when the container terminates. To prevent this, we can use a
 mount.
 
-Mounting will allow your local ModEM code direcotry to be mounted into the
+Mounting will allow your local ModEM code directory to be mounted into the
 docker container. That way any change you make in one will be reflected on the
 other.
 
@@ -426,7 +426,7 @@ Specifying mounts points
     https://docs.docker.com/engine/storage/bind-mounts/.
 
 You may want to add additional mounts in your docker container. For example, you
-might want to include the ModEM-Examples direcotry:
+might want to include the ModEM-Examples directory:
 
 .. code-block:: bash