SpECTRE Documentation Coverage Report
Current view: top level - __w/spectre/spectre/docs/Installation - InstallationOnClusters.md Hit Total Coverage
Commit: ebec864322c50bab8dca0a90baf8d01875114261 Lines: 0 1 0.0 %
Date: 2020-11-25 20:28:50
Legend: Lines: hit not hit

          Line data    Source code
       1           0 : \cond NEVER
       2             : Distributed under the MIT License.
       3             : See LICENSE.txt for details.
       4             : \endcond
       5             : # Installation on Clusters {#installation_on_clusters}
       6             : 
       7             : The installation instructions are the same for most systems because we use shell
       8             : scripts to set up the environment for each supercomputer. We describe the
       9             : generic installation instructions once, and only note special instructions if
      10             : necessary for the particular system. If you have already built SpECTRE and just
      11             : want to load the modules, source the shell file for your system and run
      12             : `spectre_load_modules`.
      13             : 
      14             : \note Sample submit scripts for some systems are available in
      15             : `support/SubmitScripts`.
      16             : 
      17             : ## General Instructions
      18             : 
      19             : 1. Run `export SPECTRE_HOME=/path/to/where/you/want/to/clone`
      20             : 2. Clone SpECTRE using `git clone SPECTRE_URL $SPECTRE_HOME`
      21             : 3. Run `cd $SPECTRE_HOME && mkdir build && cd build`
      22             : 4. Run `. $SPECTRE_HOME/support/Environments/SYSTEM_TO_RUN_ON_gcc.sh`, where
      23             :    `SYSTEM_TO_RUN_ON` is replaced by the name of the system as described in the
      24             :    relevant section below.
      25             : 5. If you haven't already installed the dependencies, run
      26             :    `export SPECTRE_DEPS=/path/to/where/you/want/the/deps`
      27             :    Then run `spectre_setup_modules $SPECTRE_DEPS`. This
      28             :    will take a while to finish. Near the end the command will tell you how to
      29             :    make the modules available by providing a `module use` command. Make
      30             :    sure you are providing an absolute path to `spectre_setup_modules`.
      31             : 6. Run `module use $SPECTRE_DEPS/modules`
      32             : 7. Run `spectre_run_cmake`, if you get module loading errors run
      33             :    `spectre_unload_modules` and try running `spectre_run_cmake` again. CMake
      34             :    should set up successfully.
      35             : 8. Build the targets you are interested in by running, e.g.
      36             :    `make -j4 test-executables`
      37             : 
      38             : ## BlueWaters at the National Center for Supercomputing Applications
      39             : 
      40             : First run `module load bwpy && bwpy-environ`, then follow the general
      41             : instructions using `bluewaters` as the `SYSTEM_TO_RUN_ON`. Note that once the
      42             : installation is completed, you will still need to run
      43             : `module load bwpy && bwpy-environ` in order to run SpECTRE. Also note that
      44             : adding this command to your `.bashrc` may cause BlueWaters to hang; you must
      45             : run this command from the command line.
      46             : 
      47             : #### Running tests on BlueWaters
      48             : 
      49             : You cannot just run `make test` or `ctest` on BlueWaters.
      50             : To run the tests:
      51             : 1. Get an interactive node using, e.g. `qsub -q debug -I -l nodes=1:ppn=16:xe -l
      52             :    walltime=00:30:00` or see the [BlueWaters documentation]
      53             :    (https://bluewaters.ncsa.illinois.edu/interactive-jobs)
      54             : 2. Setup the bwpy environment `module load bwpy && bwpy-environ`
      55             : 3. Run the `module use` command you did earlier
      56             : 4. Load the module using the `spectre_load_modules` command
      57             : 5. Run
      58             :    ```
      59             :    aprun -n1 -d1 -- bwpy-environ -- \
      60             :      $SPECTRE_HOME/build/bin/NonFailureTestsRunTests.sh
      61             :    ```
      62             : 
      63             : ## Cedar, Graham, and Niagara at ComputeCanada
      64             : 
      65             : Use `compute_canada` as the `SYSTEM_TO_RUN_ON` in the general instructions.
      66             : 
      67             : ## Frontera at TACC
      68             : 
      69             : Follow the general instructions, using `frontera` for `SYSTEM_TO_RUN_ON`.
      70             : 
      71             : ## Wheeler at Caltech
      72             : 
      73             : Follow the general instructions using `wheeler` for `SYSTEM_TO_RUN_ON`, except
      74             : you do not need to install any dependencies, so you can skip steps 5 and 6. You
      75             : can optionally compile using LLVM/Clang by sourcing `wheeler_clang.sh` instead
      76             : of `wheeler_gcc.sh`
      77             : 
      78             : ## Ocean at Fullerton
      79             : 
      80             : Follow the general instructions, using `ocean` for `SYSTEM_TO_RUN_ON`,
      81             : you do not need to install any dependencies, so you can skip steps 5 and 6.

Generated by: LCOV version 1.14