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

[WIP] Update install documentation for Brew #4468

Open
wants to merge 4 commits into
base: development
Choose a base branch
from

Conversation

aveksler1
Copy link
Contributor

I updated the installation documentation for Brew.
It was previously "coming soon...", so I updated it to reflect the brew dependency installation as outlined in the macos.yml file used in github workflows.
Users are then pointed to install using CMake.

Here is a preview of the docs:
image

@ax3l ax3l added component: documentation Docs, readme and manual install labels Dec 4, 2023
@ax3l
Copy link
Member

ax3l commented Dec 4, 2023

Hi @aveksler1, thanks a lot for the PR!

The docs for dependencies for from-source install are linked here: https://warpx.readthedocs.io/en/latest/install/dependencies.html#brew-macos-linux

What I envisioned for the doc you currently updated is a package like this:

@ax3l ax3l self-requested a review December 4, 2023 21:17
@ax3l ax3l self-assigned this Dec 4, 2023
@ax3l ax3l changed the title Update install documentation for Brew. [WIP] Update install documentation for Brew Dec 4, 2023
@aveksler1
Copy link
Contributor Author

Ah sorry for misunderstanding. How much work do you think creating a homewbrew formula would be? If it's not a huge undertaking, I'd be interested in doing this, but otherwise I'll just close this.

@ax3l
Copy link
Member

ax3l commented Dec 5, 2023

Hi @aveksler1,

since we can build WarpX now for all four dimensions at once, this should be easy :)

I started a new repo: https://github.com/ECP-WarpX/homebrew-blast

One can tap it via

brew update
brew tap ecp-warpx/blast

and after that install formulas of the kind:

brew install warpx

Take a look at https://github.com/openPMD/homebrew-openPMD/blob/master/Formula/openpmd-api.rb if you like and fill the Formula/warpx.rb accordingly with it?
I added a quick draft here: https://github.com/ECP-WarpX/homebrew-blast/blob/main/Formula/warpx.rb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants