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

Update Apple Silicon docs #6038

Merged

Conversation

geoffrey4444
Copy link
Contributor

Proposed changes

The docs for building spectre on Apple Silicon were out of date. This updates the docs. Along the way, I figured out how to get spectre to build with shared libraries, which the instructions now recommend.

Specific changes:

  • Removes instructions to build brigand and libsharp, since these are now bundled with spectre
  • Fix missing openblas install in homebrew installation instructions
  • Change charm++ instructions to i)built with shared libraries, and ii) build without ROMIO, which we don't use but which doesn't build for me for some reason I couldn't figure out
  • Instructions now support building with shared libraries on and python bindings on (before they were off)
  • Added a one liner at the end on how to install the python bindings in the user's python environment

Depends on #6036

Upgrade instructions

The instructions for building spectre on Apple Silicon have been updated, including enabling python bindings and building with shared libraries instead of static libraries.

Code review checklist

  • The code is documented and the documentation renders correctly. Run
    make doc to generate the documentation locally into BUILD_DIR/docs/html.
    Then open index.html.
  • The code follows the stylistic and code quality guidelines listed in the
    code review guide.
  • The PR lists upgrade instructions and is labeled bugfix or
    new feature if appropriate.

Further comments

@geoffrey4444 geoffrey4444 requested a review from nilsvu May 29, 2024 16:37
@geoffrey4444 geoffrey4444 added the dependent Needs a different PR to be merged in first label May 29, 2024
docs/Installation/InstallationOnAppleSilicon.md Outdated Show resolved Hide resolved
docs/Installation/InstallationOnAppleSilicon.md Outdated Show resolved Hide resolved
@geoffrey4444
Copy link
Contributor Author

Thanks very much for taking a look at this, @nilsvu ! Because your changes were all very small one-liners, I squashed immediately. Ready for another look when you get a chance

@nilsvu nilsvu enabled auto-merge June 2, 2024 23:57
@nilsvu nilsvu merged commit 18ab8dc into sxs-collaboration:develop Jun 3, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependent Needs a different PR to be merged in first documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants