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

README: update installation instructions to build PySolid from source #102

Merged
merged 1 commit into from
Feb 25, 2025

Conversation

AndreHauschild
Copy link
Contributor

@AndreHauschild AndreHauschild commented Feb 24, 2025

Change pip command to use the local PySolid repository when installing the cloned repository. Fix export command of python path.

Summary by Sourcery

Fixes the installation instructions in the README to correctly build PySolid from source, updating the pip install command to use the local PySolid repository and correcting the path in the export command.

Bug Fixes:

  • Fixes the installation instructions in the README to correctly build PySolid from source.
  • The pip install command now uses the local PySolid repository, and the export command now includes the correct path to the PySolid main folder.

Documentation:

  • Updates the installation instructions in the README to correctly build PySolid from source.

Change pip command to use the local PySolid repository when installing
the cloned repository. Fix export command of python path.
Copy link

sourcery-ai bot commented Feb 24, 2025

Reviewer's Guide by Sourcery

This pull request modifies the installation instructions in the README.md file to correctly build PySolid from the source code. It updates the pip install commands to reference the local PySolid repository and fixes the PYTHONPATH export command to point to the correct source directory.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated pip install commands to use the local PySolid repository.
  • Modified the pip install command to include './' to specify the local PySolid directory.
  • Modified the pip install -e command to include './' to specify the local PySolid directory.
README.md
Corrected the PYTHONPATH export command to include the full path to the PySolid source directory.
  • Updated the PYTHONPATH export command to use '/PySolid/src' instead of '~/tools/PySolid'.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

codeautopilot bot commented Feb 24, 2025

PR summary

This Pull Request updates the installation instructions in the README.md file for building PySolid from source. The changes include modifying the pip commands to ensure the local PySolid repository is used when installing the cloned repository. Additionally, the export command for setting the PYTHONPATH has been corrected to guide users in specifying the correct path to the PySolid main folder. These updates aim to improve clarity and accuracy in the installation process, ensuring users can set up the environment correctly and efficiently.

Suggestion

To further enhance the clarity of the installation instructions, consider adding a brief explanation or example of what <path-to-folder> should be replaced with, especially for users who might be less familiar with setting environment variables. This could help prevent potential confusion and errors during the setup process.

This comment was generated by AI. Information provided may be incorrect.

Current plan usage: 0%

Have feedback or need help?
Documentation
[email protected]

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @AndreHauschild - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The instructions for manually compiling the Fortran code could be improved by providing more specific guidance on setting the PYTHONPATH.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Member

@yunjunz yunjunz left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you @AndreHauschild for the update!

@yunjunz yunjunz changed the title Fix installation instructions to build PySolid from source README: update installation instructions to build PySolid from source Feb 25, 2025
@yunjunz yunjunz merged commit 9ac869b into insarlab:main Feb 25, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants