Update Readme for better readability #74
Merged
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
sbyna
reviewed
Mar 7, 2023
houjun
reviewed
Mar 8, 2023
README.md
Outdated
| ./autogen.sh | ||
| ./configure --prefix=$LIBFABRIC_DIR CC=gcc CFLAG="-O2" | ||
| make -j8 | ||
| ./configure --prefix=$LIBFABRIC_DIR --disable-efa --disable-sockets CC=cc CFLAG="-O2" |
There was a problem hiding this comment.
Can you add a note here that "--disable-efa --disable-sockets" are only needed on Cori/Perlmutter
README.md
Outdated
| Now, it's time to compile and install PDC. | ||
|
|
||
| * One can replace `mpicc` to other available MPI compilers. For example, on Cori, `cc` can be used to replace `mpicc`. | ||
| * `-DCMAKE_C_FLAGS="-dynamic"` used to be required for Cori, but now it is not necessary any more. |
There was a problem hiding this comment.
Can remove this line since it no longer applies.
houjun
added a commit
that referenced
this pull request
Mar 22, 2023
* Committing clang-format changes * region partition arguments * Committing clang-format changes * Update vpicio_batch.c * Committing clang-format changes * Update vpicio_batch.c * Committing clang-format changes * Additional server timing and PDCflush_obj * Committing clang-format changes * flush all RPCs for PDC cache * Committing clang-format changes * Add flush all to vpicio_batch * Committing clang-format changes * Update vpicio_batch.c * Update vpicio_batch.c * change API name and place flush lock * Committing clang-format changes * Update pdc_obj.c * fix restart timing bug * Committing clang-format changes * flush for vpicio_batch * Committing clang-format changes * Update vpicio_batch.c * remove barriers * Committing clang-format changes * barrier back * Fix HOST_NAME_MAX undefined issue on MacOS * Fix HOST_NAME_MAX undefined issue on MacOS * Dynamic region partition Implementation of dynamic region partitioning. A metadata server dynamically assigns regions to data server depending on the workload. * Committing clang-format changes * Add posix timing * Committing clang-format changes * Rename pdc timing variables * Committing clang-format changes * Update pdc_region_cache.c * Update pdc_timing.c * Committing clang-format changes * Update pdc_timing.c * Update pdc_server.c * Update pdc_server_data.c * Committing clang-format changes * Add region local implementation * Committing clang-format changes * Update pdc_region_transfer.c * fix issues * Committing clang-format changes * Update pdc_region_transfer_metadata_query.c * Committing clang-format changes * Fix bugs * Committing clang-format changes * Update pdc_region_transfer.c * Committing clang-format changes * Mixed region partition type fix * Update pdc_timing.h * Update pdc_timing.h * Update pdc_region_transfer_metadata_query.c * Committing clang-format changes * Fix a dynamic partition bug * Committing clang-format changes * Update CMakeLists.txt * Update CMakeLists.txt * Sort out PDC timing * Update pdc.h * update timer link * Committing clang-format changes * sync with test folder * remove warnings * Update pdc.h * attribute unused. * Committing clang-format changes * Update CMakeLists.txt * Update pdc_client_server_common.c * Committing clang-format changes * Change path * Update CMakeLists.txt * test * Update pdc_timing.h * Metadata separate checkpoint and finalize * Committing clang-format changes * change the cmake layout * Committing clang-format changes * separating implementations into independent files * Committing clang-format changes * missing file * Update CMakeLists.txt * Update CMakeLists.txt * Update CMakeLists.txt * Update CMakeLists.txt * Update pdc_timing.h * Update pdc_region_transfer_metadata_query.c * Fix a dynamic allocation bug * Committing clang-format changes * Update pdc_region_transfer_metadata_query.c * Timing values * obj reset dimension implementation * Committing clang-format changes * solve compile errors * Committing clang-format changes * Update pdc_obj.c * Committing clang-format changes * Fix a bug * Committing clang-format changes * Rename files for consistency * Committing clang-format changes * Fix some conflicts * Cmake changes * Update CMakeLists.txt * Update CMakeLists.txt * Add a new API to set consistency semantics (#56) * Add consistency constants Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Ignore install directory Signed-off-by: Chen Wang <wangvsa@gmail.com> * Add a new API to set consistency semantics Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Copy consistency at transfer creation time Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Insert wait calls at transfer/close time depends on the consistency requirement Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Use the new semantics setting api in haccio Signed-off-by: Chen Wang <wangvsa@gmail.com> * Add a unit test for consistency semantics Signed-off-by: Chen Wang <wangvsa@gmail.com> Co-authored-by: github-actions <github-actions[bot]@users.noreply.github.com> * Update pdc_region_transfer.c * Committing clang-format changes * Update pdc_region_transfer.c * Set dims test * Committing clang-format changes * Fix issues at server cache * Committing clang-format changes * server cache cleanups * Update pdc_server_region_cache.c * Committing clang-format changes * Update pdc_server_region_cache.c * Committing clang-format changes * 2D set dims case * Committing clang-format changes * Update region_transfer_set_dims_2D.c * Fix dimension check bug * error code when error * 3D case for set dims * Update region_transfer_set_dims_3D.c * Update pdc_server_region_cache.c * Committing clang-format changes * Rename PDC folders * Update CMakeLists.txt * Update CMakeLists.txt * Update CMakeLists.txt * change for path * Update CMakeLists.txt * Update pdc_client_server_common.c * Update pdc_client_server_common.c * Committing clang-format changes * reset path * Fix a consistency bug, server metadata structure has to be modified along with local property * Committing clang-format changes * Server files reordering * Update CMakeLists.txt * Update README.md * Update pdc_server_region_cache.h * Update pdc_server_region_cache.c * Fix a metadata ID bug * Committing clang-format changes * Update vpicio_batch.c * Code comments and examples in C++ * Committing clang-format changes * Upload documentation to developer note section. Fixed a bug in vpicio_batch.c * Fix Cmake issues * Committing clang-format changes * Add PDC server cache to cmake * Cori scripts and results * Adding descriptions for running vpicio_batch.c on Cori * Update script_cori_shared.sh * Upload figures used by developer's note * Update readme.md * Include all figures to developer's note * Shrink font size * Update container_hashtable_checkpoint.png * Update documentations to include new APIs * Update struct type documentations with latest implementation * Committing clang-format changes * Add PDC future work * Update readme.md * Fix a couple of issues with MPI and cmake checkpoint * Update CMakeLists.txt * add local partition result * Add vpicio results * Fixed some typos * Add binary to Cmake install directory contents in bin are pdc_server.exe and close_server * Bring develop branch to current branch. * Create CMakeLists.txt * add missing file * Update CMakeLists.txt * Update github CI script * Update github CI script * Update github CI script * Add PDC Tools (#63) * update vol documentation * add tools * update pdc_ls and documentation * remove extraneous files in tools * add cjson * update pdc_ls and tools documentation * update tools documentation * fix undefined behavior * update pdc_import * update pdc tools * fix formatting * Committing clang-format changes * Fix a bug with packing local region buffer * Fix a bug with packing local region buffer * Partially fixed issues with data query * Committing clang-format changes * Remove unnecessary header * Fix compile error * Update linux.yml * Update linux.yml * Fix compile issues * Disable the skewed tests for now * Disable the skewed tests for now * Fix the issue with vpic scaling * Committing clang-format changes * Add multi-step VPIC * Committing clang-format changes * Update documentation for Perlmutter (#69) * Update getting_started.rst * Update getting_started.rst * Add fcommon flag * Change default client lookup to local server only, remove query test * Committing clang-format changes * Update server automatic flush cache to storage mechnism, minor updates to test code * Committing clang-format changes * Change default consistency to eventual * update Cori CI * update Cori CI * temporarily disable test in CI * update tests for parallel CI * update CI dependecy * set distinct directory for each test * include Perlmutter in the CI * fix path for multiple CIs * update compilation for Perlmutter * fix Perlmutter CI * update Perlmutter CI policy * change scheduler parameters * fix to enable Perlmutter CI * fix to enable Perlmutter CI * fix to enable both Cori and Perlmutter CI * further split CI * Update README.md * Update getting_started.rst * remove unnecessary install block from CMakeLists.txt (#73) * Update Readme for better readability (#74) * update the doc * update readme * update readme with `libibverb` instruction * resolve review comments * improve the readability further * review comments * Fix kvtag tests * Committing clang-format changes * Update CMakelist --------- Co-authored-by: github-actions <github-actions[bot]@users.noreply.github.com> Co-authored-by: Qiao Kang <qiaokang2015@u.northwestern.edu> Co-authored-by: Chen Wang <wangvsa@gmail.com> Co-authored-by: Qiao Kang <QKang@lbl.gov> Co-authored-by: Qiao Kang <qkang@data6.lbl.gov> Co-authored-by: Jonathan Luo <45892670+JLaoo@users.noreply.github.com> Co-authored-by: Jean Luca Bez <jlbez@lbl.gov> Co-authored-by: Zhang Wei <zhangwei217245@gmail.com>
houjun
added a commit
that referenced
this pull request
Apr 4, 2023
* Update vpicio_batch.c * Committing clang-format changes * Additional server timing and PDCflush_obj * Committing clang-format changes * flush all RPCs for PDC cache * Committing clang-format changes * Add flush all to vpicio_batch * Committing clang-format changes * Update vpicio_batch.c * Update vpicio_batch.c * change API name and place flush lock * Committing clang-format changes * Update pdc_obj.c * fix restart timing bug * Committing clang-format changes * flush for vpicio_batch * Committing clang-format changes * Update vpicio_batch.c * remove barriers * Committing clang-format changes * barrier back * Fix HOST_NAME_MAX undefined issue on MacOS * Fix HOST_NAME_MAX undefined issue on MacOS * Dynamic region partition Implementation of dynamic region partitioning. A metadata server dynamically assigns regions to data server depending on the workload. * Committing clang-format changes * Add posix timing * Committing clang-format changes * Rename pdc timing variables * Committing clang-format changes * Update pdc_region_cache.c * Update pdc_timing.c * Committing clang-format changes * Update pdc_timing.c * Update pdc_server.c * Update pdc_server_data.c * Committing clang-format changes * Add region local implementation * Committing clang-format changes * Update pdc_region_transfer.c * fix issues * Committing clang-format changes * Update pdc_region_transfer_metadata_query.c * Committing clang-format changes * Fix bugs * Committing clang-format changes * Update pdc_region_transfer.c * Committing clang-format changes * Mixed region partition type fix * Update pdc_timing.h * Update pdc_timing.h * Update pdc_region_transfer_metadata_query.c * Committing clang-format changes * Fix a dynamic partition bug * Committing clang-format changes * Update CMakeLists.txt * Update CMakeLists.txt * Sort out PDC timing * Update pdc.h * update timer link * Committing clang-format changes * sync with test folder * remove warnings * Update pdc.h * attribute unused. * Committing clang-format changes * Update CMakeLists.txt * Update pdc_client_server_common.c * Committing clang-format changes * Change path * Update CMakeLists.txt * test * Update pdc_timing.h * Metadata separate checkpoint and finalize * Committing clang-format changes * change the cmake layout * Committing clang-format changes * separating implementations into independent files * Committing clang-format changes * missing file * Update CMakeLists.txt * Update CMakeLists.txt * Update CMakeLists.txt * Update CMakeLists.txt * Update pdc_timing.h * Update pdc_region_transfer_metadata_query.c * Fix a dynamic allocation bug * Committing clang-format changes * Update pdc_region_transfer_metadata_query.c * Timing values * obj reset dimension implementation * Committing clang-format changes * solve compile errors * Committing clang-format changes * Update pdc_obj.c * Committing clang-format changes * Fix a bug * Committing clang-format changes * Rename files for consistency * Committing clang-format changes * Fix some conflicts * Cmake changes * Update CMakeLists.txt * Update CMakeLists.txt * Add a new API to set consistency semantics (#56) * Add consistency constants Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Ignore install directory Signed-off-by: Chen Wang <wangvsa@gmail.com> * Add a new API to set consistency semantics Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Copy consistency at transfer creation time Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Insert wait calls at transfer/close time depends on the consistency requirement Signed-off-by: Chen Wang <wangvsa@gmail.com> * Committing clang-format changes * Use the new semantics setting api in haccio Signed-off-by: Chen Wang <wangvsa@gmail.com> * Add a unit test for consistency semantics Signed-off-by: Chen Wang <wangvsa@gmail.com> Co-authored-by: github-actions <github-actions[bot]@users.noreply.github.com> * Update pdc_region_transfer.c * Committing clang-format changes * Update pdc_region_transfer.c * Set dims test * Committing clang-format changes * Fix issues at server cache * Committing clang-format changes * server cache cleanups * Update pdc_server_region_cache.c * Committing clang-format changes * Update pdc_server_region_cache.c * Committing clang-format changes * 2D set dims case * Committing clang-format changes * Update region_transfer_set_dims_2D.c * Fix dimension check bug * error code when error * 3D case for set dims * Update region_transfer_set_dims_3D.c * Update pdc_server_region_cache.c * Committing clang-format changes * Rename PDC folders * Update CMakeLists.txt * Update CMakeLists.txt * Update CMakeLists.txt * change for path * Update CMakeLists.txt * Update pdc_client_server_common.c * Update pdc_client_server_common.c * Committing clang-format changes * reset path * Fix a consistency bug, server metadata structure has to be modified along with local property * Committing clang-format changes * Server files reordering * Update CMakeLists.txt * Update README.md * Update pdc_server_region_cache.h * Update pdc_server_region_cache.c * Fix a metadata ID bug * Committing clang-format changes * Update vpicio_batch.c * Code comments and examples in C++ * Committing clang-format changes * Upload documentation to developer note section. Fixed a bug in vpicio_batch.c * Fix Cmake issues * Committing clang-format changes * Add PDC server cache to cmake * Cori scripts and results * Adding descriptions for running vpicio_batch.c on Cori * Update script_cori_shared.sh * Upload figures used by developer's note * Update readme.md * Include all figures to developer's note * Shrink font size * Update container_hashtable_checkpoint.png * Update documentations to include new APIs * Update struct type documentations with latest implementation * Committing clang-format changes * Add PDC future work * Update readme.md * Fix a couple of issues with MPI and cmake checkpoint * Update CMakeLists.txt * add local partition result * Add vpicio results * Fixed some typos * Add binary to Cmake install directory contents in bin are pdc_server.exe and close_server * Bring develop branch to current branch. * Create CMakeLists.txt * add missing file * Update CMakeLists.txt * Update github CI script * Update github CI script * Update github CI script * Add PDC Tools (#63) * update vol documentation * add tools * update pdc_ls and documentation * remove extraneous files in tools * add cjson * update pdc_ls and tools documentation * update tools documentation * fix undefined behavior * update pdc_import * update pdc tools * fix formatting * Committing clang-format changes * Fix a bug with packing local region buffer * Fix a bug with packing local region buffer * Partially fixed issues with data query * Committing clang-format changes * Remove unnecessary header * Fix compile error * Update linux.yml * Update linux.yml * Fix compile issues * Disable the skewed tests for now * Disable the skewed tests for now * Fix the issue with vpic scaling * Committing clang-format changes * Add multi-step VPIC * Committing clang-format changes * Update documentation for Perlmutter (#69) * Update getting_started.rst * Update getting_started.rst * Add fcommon flag * Change default client lookup to local server only, remove query test * Committing clang-format changes * Update server automatic flush cache to storage mechnism, minor updates to test code * Committing clang-format changes * Change default consistency to eventual * update Cori CI * update Cori CI * temporarily disable test in CI * update tests for parallel CI * update CI dependecy * set distinct directory for each test * include Perlmutter in the CI * fix path for multiple CIs * update compilation for Perlmutter * fix Perlmutter CI * update Perlmutter CI policy * change scheduler parameters * fix to enable Perlmutter CI * fix to enable Perlmutter CI * fix to enable both Cori and Perlmutter CI * further split CI * Update README.md * Update getting_started.rst * remove unnecessary install block from CMakeLists.txt (#73) * Update Readme for better readability (#74) * update the doc * update readme * update readme with `libibverb` instruction * resolve review comments * improve the readability further * review comments * Fix kvtag tests * Committing clang-format changes * Update CMakelist * Increase the number of metadata a server can manage * Update CI * Update CI * Update linux.yml --------- Co-authored-by: Qiao Kang <qiaokang2015@u.northwestern.edu> Co-authored-by: github-actions <github-actions[bot]@users.noreply.github.com> Co-authored-by: Chen Wang <wangvsa@gmail.com> Co-authored-by: Qiao Kang <QKang@lbl.gov> Co-authored-by: Qiao Kang <qkang@data6.lbl.gov> Co-authored-by: Jonathan Luo <45892670+JLaoo@users.noreply.github.com> Co-authored-by: Jean Luca Bez <jlbez@lbl.gov> Co-authored-by: Zhang Wei <zhangwei217245@gmail.com>
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.
Update Readme for better readability