S3DF docs in template format #6442
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document the setup and usage of the S3DF cluster for WarpX.
Removed instructions for building WarpX with FFTW support.
Clarify instructions for toggling options in CMakeLists.txt.
Updated installation instructions for WarpX to include additional packages and installation steps.
Updated references and commands for building and running WarpX.
Updated the job submission command to request 2 nodes instead of 1 and added instructions for running WarpX after resource allocation.
Emphasize the need for MPI to be loaded before installing or running WarpX.
Clarified MPI loading instructions and updated job submission command details.
Updated interactive job command and bash script example for clarity.
Updated the explanation of account usage and resource allocation for S3DF. Added example command for running WarpX after resource allocation.
Removed note about Perlmutter GPU project naming convention.
Updated installation instructions for S3DF to recommend installing WarpX in the project directory and added details about project and user name placeholders.
Updated installation instructions for WarpX to include Python module installation steps.
Removed redundant CMake options section for CPU nodes to streamline documentation.
Updated instructions for running jobs on the iana pool, including interactive and script-based methods. Clarified resource allocation and provided example submission script.
Updated instructions for setting the WORK variable in .bashrc for easier access to project directories.
Updated command for running an interactive job to request 1 node instead of 2.
Updated environment variables and module loads in the profile example. Removed commented-out lines and adjusted paths for clarity.
Updated environment variables and module loading for GPU setup.
aeriforme
added
component: documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added installation documentation for S3DF cluster following the structure of the instructions for other clusters.
https://github.com/pkicsiny/WarpX/tree/s3df_docs/Docs/source/install/hpc/s3df.rst
Added files: