Add guide for potential installation

[samwaseda]

Based on this discussion I appended text to the error message. I guess @jan-janssen can update it to make it more accurate.

Summary by CodeRabbit

• New Features

  • Introduced a detailed installation guide for the potential module to assist users in setup.

• Bug Fixes

  • Enhanced error messages to include installation instructions when potential files cannot be located.

• Usability Improvements

  • Provided clear context and guidance directly within error messages to enhance user experience.

[coderabbitai]

Walkthrough

The recent changes to the potential.py file enhance user experience by incorporating a comprehensive installation guide directly within the code. This guide helps users verify their iprpy-data installation and navigate error messages. By appending the installation instructions to relevant error notifications, the updates ensure that users receive immediate context and support when encountering issues, thereby streamlining the troubleshooting process.

Changes

File	Change Summary
atomistics/calculators/lammps/potential.py	Added an installation guide for the potential module, included in error messages for improved usability.

Poem

🐇 In the realm of code where potentials gleam,
A guide now awaits like a bright, hopeful dream.
When paths go astray, don’t fret, just explore,
With tips in your hands, you’ll find knowledge galore!
So hop through the errors, let worries be few,
For coding is magic, and it starts here with you! 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1b6cb68 and 72b037d.

Files selected for processing (1)

• atomistics/calculators/lammps/potential.py (3 hunks)

Additional comments not posted (3)

atomistics/calculators/lammps/potential.py (3)

8-34: LGTM! The installation guide is clear and well-structured.

The potential_installation guide provides clear and detailed instructions for installing iprpy-data and setting the resource path.

---

155-157: LGTM! Including the installation guide in the error message is helpful.

The updated error message in _get_potential_df now provides immediate assistance to users encountering issues with locating potential files.

---

343-343: LGTM! Including the installation guide in the error message is helpful.

The updated error message in get_resource_path_from_conda now provides immediate assistance to users encountering issues with finding the resource path.

[jan-janssen]

Looks good to me