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

Remove brew-sundials from the recommended developer installations #2925

Merged
merged 3 commits into from
May 8, 2023

Conversation

jsbrittain
Copy link
Contributor

Description

The (Mac recommended) brew install procedure for sundials does not link the cmake args that are required by tox -e dev. Here, we simplify the developer installation procedure for Mac, bringing it in-line with that for linux, by using tox -e pybamm-requires to download, compile and install the SuiteSparse and SUNDIALS libraries.

Fixes #2897

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

(documentation change only)
[ ] No style issues: $ pre-commit run (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
[ ] All tests pass: $ python run-tests.py --all

  • The documentation builds: $ python run-tests.py --doctest

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link

codecov bot commented May 4, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (4f0a23d) 99.68% compared to head (4e64f21) 99.68%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2925   +/-   ##
========================================
  Coverage    99.68%   99.68%           
========================================
  Files          273      273           
  Lines        18997    18997           
========================================
  Hits         18938    18938           
  Misses          59       59           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@agriyakhetarpal
Copy link
Member

For Linux installation, and in addition to tox -e pybamm-requires – maybe the pybamm_install_odes command can be updated to also install OpenBLAS and not just SUNDIALS in a PR in the future?

This can remove the need for the note about the error A library with BLAS API not found. Please specify library location. -- LAPACK requires BLAS which is mentioned in the Troubleshooting section of the GNU/Linux installation section documentation at GNU-linux.rst

@jsbrittain jsbrittain marked this pull request as ready for review May 4, 2023 11:46
Copy link
Sponsor Member

@brosaplanella brosaplanella left a comment

Choose a reason for hiding this comment

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

Looks good to me, but I don't use Mac, so I have requested a review from Valentin who uses it

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

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

Looks good except changelog needs updating

CHANGELOG.md Outdated
@@ -21,6 +21,7 @@

## Bug fixes

- Remove brew install for Mac from the recommended developer installation options for SUNDIALS ([#2925](https://github.com/pybamm-team/PyBaMM/pull/2925))
Copy link
Member

Choose a reason for hiding this comment

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

this needs to be moved to the new section

@valentinsulzer valentinsulzer merged commit 1928b19 into pybamm-team:develop May 8, 2023
@jsbrittain jsbrittain deleted the issue-2897-brew branch May 10, 2023 08:16
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.

[Bug]: Install from source for M-Series hardware
4 participants