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.

Sign up for GitHub

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

Jump to bottom

docs: clean up deprecated deepmodeling conda channel docs #4385

Merged
merged 1 commit into from
Nov 21, 2024
Merged

docs: clean up deprecated deepmodeling conda channel docs #4385

merged 1 commit into from
Nov 21, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Nov 20, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated conda package building instructions for clarity and streamlined content.
    • Enhanced easy installation guide for DeePMD-kit, emphasizing command availability and system requirements.
    • Removed outdated installation steps and clarified requirements for offline and conda packages.
    • Reorganized pip installation instructions into tabbed sections for better usability.

Copilot
Copilot AI reviewed Nov 20, 2024
View reviewed changes

Choose a reason for hiding this comment

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no suggestions.
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

📝 Walkthrough

Walkthrough

The pull request updates documentation for building conda packages and installation instructions for DeePMD-kit. It removes outdated content related to building conda packages, including specific instructions and references to the lammps-feedstock repository. The focus shifts to directing users to conda-forge documentation. Additionally, the installation guide for DeePMD-kit is clarified, emphasizing command availability, system requirements, and reorganizing pip installation instructions while retaining Docker installation commands.

Changes

File Change Summary
doc/install/build-conda.md Updated to remove outdated instructions for building conda packages, retaining a deprecated notice. Removed detailed steps for enabling MPIIO in LAMMPS and references to lammps-feedstock. Shifted focus to conda-forge documentation.
doc/install/easy-install.md Clarified installation instructions for DeePMD-kit, specifying command availability, system requirements, and reorganizing pip installation instructions. Removed old conda environment creation commands.

Possibly related PRs

Suggested labels

Docs

Suggested reviewers

  • wanghan-iapcm
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6039e0b and 100fe9a.

📒 Files selected for processing (2)
  • doc/install/build-conda.md (0 hunks)
  • doc/install/easy-install.md (0 hunks)
💤 Files with no reviewable changes (2)
  • doc/install/build-conda.md
  • doc/install/easy-install.md

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 Nov 20, 2024
@codecov Codecov
Copy link

codecov bot commented Nov 20, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.50%. Comparing base (6039e0b) to head (100fe9a).
Report is 4 commits behind head on devel.

Additional details and impacted files 
@@           Coverage Diff           @@
##            devel    #4385   +/-   ##
=======================================
  Coverage   84.50%   84.50%           
=======================================
  Files         604      604           
  Lines       56945    56943    -2     
  Branches     3487     3486    -1     
=======================================
- Hits        48121    48120    -1     
+ Misses       7698     7696    -2     
- Partials     1126     1127    +1

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

🚨 Try these New Features:

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Nov 21, 2024
Merged via the queue into deepmodeling:devel with commit 4334377 Nov 21, 2024
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot Copilot left review comments

@wanghan-iapcm wanghan-iapcm wanghan-iapcm approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@njzjz @wanghan-iapcm