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

Install seed packages (setuptools and wheel) #317

Merged

Conversation

agriyakhetarpal
Copy link
Member

Description

This PR is a small update to noxfile.py where the nox configuration is updated to install seed packages that can be sometimes missing from uv's virtual environments (if using nox[uv]). These packages are installed with nox, which uses virtualenv as the backend for creating virtual environments, and therefore this is a failsafe change to ensure that PyBaMM can be installed along with PyBOP for platforms where wheels are not available (macOS ARM wheels started to become available with PyBaMM v24.1).

Issue reference

This change hopes to fix some of the failing scheduled tests: https://github.com/pybop-team/PyBOP/actions/runs/8999338828

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

Copy link

codecov bot commented May 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.80%. Comparing base (f6b18c0) to head (10e68f2).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #317   +/-   ##
========================================
  Coverage    95.80%   95.80%           
========================================
  Files           38       38           
  Lines         2048     2048           
========================================
  Hits          1962     1962           
  Misses          86       86           

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

@agriyakhetarpal
Copy link
Member Author

agriyakhetarpal commented May 8, 2024

Just triggered a workflow run on my fork just to see if this is working as intended, let's hope it passes: https://github.com/agriyakhetarpal/PyBOP/actions/runs/9006940642

Edit: okay, the tests that were failing earlier are the same, and the test suite is proceeding to run. This is now okay to merge, I suppose.

Copy link
Member

@BradyPlanden BradyPlanden left a comment

Choose a reason for hiding this comment

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

Thanks for the bugfix @agriyakhetarpal. We need to do a bit more on either hyper-parameter tuning or loosening of the assertions so that the scheduled tests pass consistently, but this is a step in the right direction!

@BradyPlanden BradyPlanden merged commit 7825f1a into pybop-team:develop May 9, 2024
29 checks passed
@agriyakhetarpal agriyakhetarpal deleted the install-seed-packages branch May 9, 2024 09:34
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