endeavour: add README.md in top edv directory #168
Conversation
This file contains 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
The Endeavour scripts have very little documentation on how to execute them, what each script does and expected file/directory layout. Add a README.md to the top level directory of the Endeavour scripts as a start to documenting the scripts and the expected organization of files. More documentation is needed to allow someone new to run these scripts on Endeavour. Signed-off-by: James Nunez <[email protected]>
rpadma2
reviewed
Jul 6, 2023
|
|
||
| ## Usage | ||
| All scripts expect that the RUNDIR variable is set before any script is executed and that RUNDIR is the path to the client [directory]( https://github.com/daos-stack/daos_scaled_testing/tree/master/edv/test_scripts/client). For example, if the client directory is located at /panfs/users/janunez/, then we would set: | ||
| export RUNDIR=/panfs/users/janunez/client |
There was a problem hiding this comment.
You can probably replace janunez as <username>
There was a problem hiding this comment.
Recommend formatting code
Suggested change
| export RUNDIR=/panfs/users/janunez/client | |
| `export RUNDIR=/panfs/users/janunez/client` |
|
|
||
| #### Environment Variables - server | ||
| The following variables are set inside the $RUNDIR/../server/srv_env.sh and can be changed to match your environment: | ||
| export DAOS_INSTALL=/panfs/users/janunez/builds/$TB/install |
There was a problem hiding this comment.
Suggested change
| export DAOS_INSTALL=/panfs/users/janunez/builds/$TB/install | |
| `export DAOS_INSTALL=/panfs/users/janunez/builds/$TB/install` |
rpadma2
approved these changes
Jul 6, 2023
|
|
||
| ## Usage | ||
| All scripts expect that the RUNDIR variable is set before any script is executed and that RUNDIR is the path to the client [directory]( https://github.com/daos-stack/daos_scaled_testing/tree/master/edv/test_scripts/client). For example, if the client directory is located at /panfs/users/janunez/, then we would set: | ||
| export RUNDIR=/panfs/users/janunez/client |
There was a problem hiding this comment.
Recommend formatting code
Suggested change
| export RUNDIR=/panfs/users/janunez/client | |
| `export RUNDIR=/panfs/users/janunez/client` |
|
|
||
| #### Environment Variables - server | ||
| The following variables are set inside the $RUNDIR/../server/srv_env.sh and can be changed to match your environment: | ||
| export DAOS_INSTALL=/panfs/users/janunez/builds/$TB/install |
There was a problem hiding this comment.
Suggested change
| export DAOS_INSTALL=/panfs/users/janunez/builds/$TB/install | |
| `export DAOS_INSTALL=/panfs/users/janunez/builds/$TB/install` |
|
|
||
| ## Running Applications | ||
| The scripts located in $RUNDIR/testlists contain the scripts to run applications. An example call to run LAMMPS is | ||
| ./testlists/testlist_lammps.sh -d -s servers -c clients -p ppn -m mpi -t mptype -b tb -r rf -i il -e size -k chunk_size -o oclass -z start |
There was a problem hiding this comment.
Suggested change
| ./testlists/testlist_lammps.sh -d -s servers -c clients -p ppn -m mpi -t mptype -b tb -r rf -i il -e size -k chunk_size -o oclass -z start | |
| `./testlists/testlist_lammps.sh -d -s servers -c clients -p ppn -m mpi -t mptype -b tb -r rf -i il -e size -k chunk_size -o oclass -z start` |
Comment on lines
+38
to
+50
| -d Collect Darshan logs | ||
| -s Server List (eg: 2,4,8,16,32) | ||
| -c Total clients to use | ||
| -p Processes per node (default: 64) | ||
| -m Type of MPI to use (MPI, IMPI) | ||
| -b DAOS Test Build to use (eg: daos_xxx) | ||
| -r DAOS Redundancy Factor(eg: rf=0,1,..) | ||
| -i DAOS Interception library(eg: il=0,1) | ||
| -e DAOS container property: cell size in bytes (eg: 1048576 for 1MB) | ||
| -k DAOS container property: chunk size (eg: 4MB) | ||
| -o DAOS container property: object class (oclass) (eg EC_4P2GX, EC_8P2GX) | ||
| -t DAOS MPI Type(eg: mptype=FPP, MPIIO, MPIIODFS) | ||
| -z Setup DAOS servers and clients (start_server, start_client), run application (app), or clean up (stop_client, stop_server) |
There was a problem hiding this comment.
If you look at the file in the rich view:
https://github.com/daos-stack/daos_scaled_testing/blob/ac2e3db7af258485904f72f8620cd9a3dddbee20/edv/README.md
Formatting for newlines is not respected. Since this is code, you could just format with three backticks before and after
Suggested change
| -d Collect Darshan logs | |
| -s Server List (eg: 2,4,8,16,32) | |
| -c Total clients to use | |
| -p Processes per node (default: 64) | |
| -m Type of MPI to use (MPI, IMPI) | |
| -b DAOS Test Build to use (eg: daos_xxx) | |
| -r DAOS Redundancy Factor(eg: rf=0,1,..) | |
| -i DAOS Interception library(eg: il=0,1) | |
| -e DAOS container property: cell size in bytes (eg: 1048576 for 1MB) | |
| -k DAOS container property: chunk size (eg: 4MB) | |
| -o DAOS container property: object class (oclass) (eg EC_4P2GX, EC_8P2GX) | |
| -t DAOS MPI Type(eg: mptype=FPP, MPIIO, MPIIODFS) | |
| -z Setup DAOS servers and clients (start_server, start_client), run application (app), or clean up (stop_client, stop_server) |
-d Collect Darshan logs
-s Server List (eg: 2,4,8,16,32)
-c Total clients to use
-p Processes per node (default: 64)
-m Type of MPI to use (MPI, IMPI)
-b DAOS Test Build to use (eg: daos_xxx)
-r DAOS Redundancy Factor(eg: rf=0,1,..)
-i DAOS Interception library(eg: il=0,1)
-e DAOS container property: cell size in bytes (eg: 1048576 for 1MB)
-k DAOS container property: chunk size (eg: 4MB)
-o DAOS container property: object class (oclass) (eg EC_4P2GX, EC_8P2GX)
-t DAOS MPI Type(eg: mptype=FPP, MPIIO, MPIIODFS)
-z Setup DAOS servers and clients (start_server, start_client), run application (app), or clean up (stop_client, stop_server)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The Endeavour scripts have very little documentation on how to execute them, what each script does and expected file/directory layout. Add a README.md to the top level directory of the Endeavour scripts as a start to documenting the scripts and the expected organization of files.
More documentation is needed to allow someone new to run these scripts on Endeavour.