Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: bump LAMMPS to stable_29Aug2024_update1 #4179

Merged

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 2, 2024

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated installation instructions to reference the new LAMMPS version stable_29Aug2024_update1.
  • New Features

    • Enhanced build scripts to support the updated LAMMPS version across various installation methods.
  • Chores

    • Adjusted dependency management settings to reflect the new LAMMPS version in configuration files.

Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve updates to the version of the LAMMPS source code referenced across various files. The original version stable_29Aug2024 has been replaced with stable_29Aug2024_update1 in documentation, build scripts, and configuration files. This includes updates to download commands, directory paths, and environment variables, ensuring that all components point to the correct version of LAMMPS for installation and testing.

Changes

File Change Summary
doc/install/install-lammps.md Updated references from stable_29Aug2024 to stable_29Aug2024_update1 in installation instructions.
pyproject.toml Updated lmp dependency version to "lammps~=2024.8.29.1.0" and modified DP_LAMMPS_VERSION to stable_29Aug2024_update1. Expanded test-command section.
source/install/build_cc.sh Changed LAMMPS version from stable_29Aug2024 to stable_29Aug2024_update1 in cmake command.
source/install/build_from_c.sh Updated LAMMPS version in CMake command from stable_29Aug2024 to stable_29Aug2024_update1.
source/install/build_lammps.sh Updated download version from stable_29Aug2024 to stable_29Aug2024_update1.
source/install/test_cc.sh Changed LAMMPS_VERSION from stable_29Aug2024 to stable_29Aug2024_update1 in the build command.
source/install/test_cc_local.sh Updated LAMMPS_VERSION from stable_29Aug2024 to stable_29Aug2024_update1 in CMake configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Installer
    participant LAMMPS

    User->>Installer: Request Installation
    Installer->>LAMMPS: Download stable_29Aug2024_update1
    LAMMPS-->>Installer: Provide Source Code
    Installer->>Installer: Configure Build with stable_29Aug2024_update1
    Installer->>Installer: Execute Build Process
    Installer-->>User: Installation Complete
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the Docs label Oct 2, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
source/install/build_from_c.sh (1)

16-16: LGTM! Consider using a variable for the LAMMPS version.

The update to the LAMMPS version aligns with the PR objective. Good job on keeping the build script up-to-date.

For improved maintainability, consider defining the LAMMPS version as a variable at the beginning of the script. This would make future updates easier and reduce the risk of inconsistencies. For example:

 set -e
 
+LAMMPS_VERSION="stable_29Aug2024_update1"
+
 SCRIPT_PATH=$(dirname $(realpath -s $0))
 if [ -z "$INSTALL_PREFIX" ]; then
 	INSTALL_PREFIX=$(realpath -s ${SCRIPT_PATH}/../../dp)
 fi
 mkdir -p ${INSTALL_PREFIX}
 echo "Installing DeePMD-kit to ${INSTALL_PREFIX}"
 NPROC=$(nproc --all)
 
 #------------------
 
 BUILD_TMP_DIR=${SCRIPT_PATH}/../build
 mkdir -p ${BUILD_TMP_DIR}
 cd ${BUILD_TMP_DIR}
-cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX} -DDEEPMD_C_ROOT=${DEEPMD_C_ROOT} -DLAMMPS_VERSION=stable_29Aug2024_update1 ..
+cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX} -DDEEPMD_C_ROOT=${DEEPMD_C_ROOT} -DLAMMPS_VERSION=${LAMMPS_VERSION} ..
 cmake --build . -j${NPROC}
 cmake --install .
 cmake --build . --target=lammps

This change would make it easier to update the LAMMPS version in future PRs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ad8bebe and 6b813fc.

📒 Files selected for processing (7)
  • doc/install/install-lammps.md (4 hunks)
  • pyproject.toml (3 hunks)
  • source/install/build_cc.sh (1 hunks)
  • source/install/build_from_c.sh (1 hunks)
  • source/install/build_lammps.sh (1 hunks)
  • source/install/test_cc.sh (1 hunks)
  • source/install/test_cc_local.sh (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • doc/install/install-lammps.md
  • source/install/build_cc.sh
  • source/install/test_cc_local.sh
🔇 Additional comments (6)
source/install/test_cc.sh (1)

20-20: LGTM. Verify build success with the new LAMMPS version.

The update of LAMMPS version from stable_29Aug2024 to stable_29Aug2024_update1 is consistent with the PR objective. This minor version update likely includes bug fixes or small improvements.

To ensure compatibility and successful builds with the new LAMMPS version, please run the following verification script:

source/install/build_lammps.sh (1)

17-17: LGTM. Version update looks good, but let's verify a few things.

The LAMMPS version has been updated from 'stable_29Aug2024' to 'stable_29Aug2024_update1'. This change looks straightforward and correct.

To ensure everything works as expected with this new version, please consider the following verification steps:

  1. Confirm that the new version exists and is downloadable:

  2. Check for any breaking changes or important updates in the release notes for this version:

  3. Ensure that the build process completes successfully with the new version in your CI/CD pipeline.

  4. If possible, run your test suite to confirm that the new LAMMPS version doesn't introduce any regressions in your specific use case.

pyproject.toml (4)

107-107: Summary: LAMMPS version update across configurations

The changes in this PR are focused on updating the LAMMPS version from 2024.8.29.0.0 to 2024.8.29.1.0 and reflecting this update in the build configurations for both macOS and Linux. These changes are consistent and aligned with the PR objective.

Key points:

  1. LAMMPS dependency version updated to 2024.8.29.1.0
  2. DP_LAMMPS_VERSION updated to "stable_29Aug2024_update1" for both macOS and Linux

The impact of these changes should be minimal, primarily affecting the LAMMPS integration. However, it's crucial to ensure that the new LAMMPS version is compatible with the existing codebase and that the build processes for both macOS and Linux continue to function correctly.

To ensure overall compatibility and correct functioning, please run the full test suite and verify that all LAMMPS-related functionality works as expected across different operating systems.

Also applies to: 228-228, 264-264


228-228: LGTM: DP_LAMMPS_VERSION update for macOS

The DP_LAMMPS_VERSION has been updated to "stable_29Aug2024_update1", which is consistent with the LAMMPS version change and the PR objective.

To ensure this change doesn't break the macOS build process, please verify with the following command:

#!/bin/bash
# Description: Verify macOS build environment
# Test: Check if DP_LAMMPS_VERSION is set correctly
echo $DP_LAMMPS_VERSION

264-264: LGTM: DP_LAMMPS_VERSION update for Linux

The DP_LAMMPS_VERSION has been updated to "stable_29Aug2024_update1" for Linux as well, maintaining consistency with the macOS configuration and aligning with the PR objective.

To ensure this change doesn't affect the Linux build process, please verify with the following command:

#!/bin/bash
# Description: Verify Linux build environment
# Test: Check if DP_LAMMPS_VERSION is set correctly and LAMMPS can be imported
echo $DP_LAMMPS_VERSION
python -c "import lammps; print(lammps.__version__)"

107-107: LGTM: LAMMPS version update

The LAMMPS version has been updated from 2024.8.29.0.0 to 2024.8.29.1.0, which aligns with the PR objective. This minor version update should introduce improvements or bug fixes.

To ensure compatibility, please verify that this version works correctly with the current codebase. Consider running the following command to check for any potential issues:

Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.46%. Comparing base (ad8bebe) to head (6b813fc).
Report is 2 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4179   +/-   ##
=======================================
  Coverage   83.46%   83.46%           
=======================================
  Files         537      537           
  Lines       52168    52168           
  Branches     3046     3046           
=======================================
  Hits        43543    43543           
  Misses       7678     7678           
  Partials      947      947           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Oct 2, 2024
Merged via the queue into deepmodeling:devel with commit 7ce5b03 Oct 2, 2024
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants