From ce3304b94ac44fbc41f50fba9f33ffb8c54b5e08 Mon Sep 17 00:00:00 2001 From: Sylwester Arabas Date: Tue, 26 Mar 2024 17:59:06 +0100 Subject: [PATCH 1/4] add FAQ entry about how to pip-install PyPartMC with MOSAIC enabled --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c27fe876..cd2187ee 100644 --- a/README.md +++ b/README.md @@ -282,6 +282,9 @@ flowchart TD ``` ## FAQ +- Q: How to install PyPartMC with MOSAIC enabled? + A: `MOSAIC_HOME=<> pip install --no-binary=PyPartMC PyPartMC` + - Q: Why `pip install PyPartMC` triggers compilation on my brand new Apple machine, while it quickly downloads and installs binary packages when executed on older Macs, Windows or Linux? A: We are not yet providing binary wheels on PyPI for Apple-silicon (arm64) machines. Cross-compilation with gfortran is only supported with experimental unofficial builds [and is tricky](https://github.com/iains/gcc-12-branch/issues/23), while Github Actions ARM64 virtual machines are [costly](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#minute-multipliers). From 3e9c5aaaf385c46fd7e7f38e76a874c3ab2e2712 Mon Sep 17 00:00:00 2001 From: Jeffrey Curtis Date: Tue, 26 Mar 2024 19:48:20 -0500 Subject: [PATCH 2/4] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd2187ee..243d8e88 100644 --- a/README.md +++ b/README.md @@ -283,7 +283,7 @@ flowchart TD ## FAQ - Q: How to install PyPartMC with MOSAIC enabled? - A: `MOSAIC_HOME=<> pip install --no-binary=PyPartMC PyPartMC` + A: `MOSAIC_HOME=<> pip install --no-binary=PyPartMC PyPartMC` - Q: Why `pip install PyPartMC` triggers compilation on my brand new Apple machine, while it quickly downloads and installs binary packages when executed on older Macs, Windows or Linux? A: We are not yet providing binary wheels on PyPI for Apple-silicon (arm64) machines. Cross-compilation with gfortran is only supported with experimental unofficial builds [and is tricky](https://github.com/iains/gcc-12-branch/issues/23), while Github Actions ARM64 virtual machines are [costly](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#minute-multipliers). From 278d721233fa9b20fcfa10e45bc92bf1cdaa6400 Mon Sep 17 00:00:00 2001 From: Sylwester Arabas Date: Wed, 27 Mar 2024 08:54:48 +0100 Subject: [PATCH 3/4] improve MOSAIC install FAQ entry to cover the case of pre-existin PyPartMC installation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 243d8e88..9faf7cd2 100644 --- a/README.md +++ b/README.md @@ -283,7 +283,7 @@ flowchart TD ## FAQ - Q: How to install PyPartMC with MOSAIC enabled? - A: `MOSAIC_HOME=<> pip install --no-binary=PyPartMC PyPartMC` + A: `MOSAIC_HOME=<> pip install --force-reinstall --no-binary=PyPartMC PyPartMC` - Q: Why `pip install PyPartMC` triggers compilation on my brand new Apple machine, while it quickly downloads and installs binary packages when executed on older Macs, Windows or Linux? A: We are not yet providing binary wheels on PyPI for Apple-silicon (arm64) machines. Cross-compilation with gfortran is only supported with experimental unofficial builds [and is tricky](https://github.com/iains/gcc-12-branch/issues/23), while Github Actions ARM64 virtual machines are [costly](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#minute-multipliers). From 2ce4ae6f10e81d9dc54d8e275b75f95a96809b5b Mon Sep 17 00:00:00 2001 From: Sylwester Arabas Date: Wed, 27 Mar 2024 08:58:42 +0100 Subject: [PATCH 4/4] add some explanation on why the pip command is formulated as given in the answer --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9faf7cd2..38e378f4 100644 --- a/README.md +++ b/README.md @@ -283,7 +283,10 @@ flowchart TD ## FAQ - Q: How to install PyPartMC with MOSAIC enabled? - A: `MOSAIC_HOME=<> pip install --force-reinstall --no-binary=PyPartMC PyPartMC` + A: Installation can be done using `pip`, however, `pip` needs to be instructed not to use binary packages available at pypi.org but rather to compile from source (pip will download the source from pip.org), and the path to compiled MOSAIC library needs to be provided at compile-time; the following command should convey it: +```bash +MOSAIC_HOME=<> pip install --force-reinstall --no-binary=PyPartMC PyPartMC +``` - Q: Why `pip install PyPartMC` triggers compilation on my brand new Apple machine, while it quickly downloads and installs binary packages when executed on older Macs, Windows or Linux? A: We are not yet providing binary wheels on PyPI for Apple-silicon (arm64) machines. Cross-compilation with gfortran is only supported with experimental unofficial builds [and is tricky](https://github.com/iains/gcc-12-branch/issues/23), while Github Actions ARM64 virtual machines are [costly](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#minute-multipliers).