Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

<center><h1 id="installation">Installation</h1></center>

<p>When you have Python 3.9 to 3.14 installed (CPython, 64-bit ,x86_64), </p>
<p>When you have Python 3.10 or higher installed (CPython, 64-bit), </p>
<codebox>
<p>python -m pip install pyoomph</p>
</codebox>

<p>should install the basic framework. On Macs with Apple silicon (arm64, e.g. M1-M4) processor systems, please execute it in a Rosetta2 terminal (see below).
<p>should install the recent release.
For maximum performance and system-specific information, please refer to the sections below. </p>

<p>If you cannot manage to install it, refer to our <a href="https://pyoomph.readthedocs.io/">tutorial</a>. If this cannot help, you can ask for help (c.diddens@utwente.nl)</p>
Expand All @@ -31,19 +31,26 @@

<center><h2 id="on-mac">On Mac</h2></center>

<p><strong>If you have a recent Mac with an Apple silicon (arm64) chip</strong>, you must run all commands in a <code>Rosetta 2 terminal</code>, see <a href="https://www.courier.com/blog/tips-and-tricks-to-setup-your-apple-m1-for-development/">here</a> how to set it up (note that recent systems must be handled as described <a href="https://developer.apple.com/forums/thread/718666">here</a>). Also, please make sure to not upgrade your <code>mkl</code> package, i.e. enforce it to version 2021.4.0. Alternatively, you can compile it directly on arm64, but with the downside of not being able to use the fast Pardiso solver. See <a href="https://pyoomph.readthedocs.io/en/latest/tutorial/installation/source/mac.html">here</a> for details. Also, you might have to use a less recent version of python. See <a href="https://github.com/pyoomph/pyoomph/blob/main/Mac_arm64_with_Pardiso.md">here</a> for details.</p>

<codebox>
<p><strong>If you have a recent Mac with an Apple silicon (arm64) chip</strong>, mind the following:
Python cannot install the fast <code>MKL Pardiso solver</code> on arm64 natively and will use <code>Accelerate</code> by default, which becomes unacceptably slow for larger problems. There are two workarounds, either install pyoomph in a <code>Rosetta 2 terminal</code> to use MKL Pardiso or install <code>PETSc/SLEPc</code> and use <code>MUMPS</code> as fast linear solver instead.

For the first option, you must run the installation command above in a <code>Rosetta 2 terminal</code>, see <a href="https://www.courier.com/blog/tips-and-tricks-to-setup-your-apple-m1-for-development/">here</a> how to set it up (note that recent systems must be handled as described <a href="https://developer.apple.com/forums/thread/718666">here</a>). Also, please make sure to not upgrade your <code>mkl</code> package, i.e. enforce it to version 2021.4.0.</p>

<codebox>
<p>python3 -m pip install mkl==2021.4.0</p>
</codebox>

<p> See <a href="https://pyoomph.readthedocs.io/en/latest/tutorial/installation/source/mac.html">here</a> for further details. Also, you might have to use a less recent version of python, see <a href="https://github.com/pyoomph/pyoomph/blob/main/Mac_arm64_with_Pardiso.md">here</a> for details.</p>

<p>For the second option (PETSc with MUMPS), please refer to <a href="https://pyoomph.readthedocs.io/en/latest/tutorial/installation/petscslepc.html">the installation instructions</a>.</p>


<p>Make sure to have the <code>XCode</code> developer tools, e.g., by installing them via</p>
<p>In any case, make sure to have the <code>XCode</code> developer tools, e.g., by installing them via</p>

<codebox>
<p>xcode-select --install</p>
</codebox>

<p>and test pyoomph via</p>
<p>(in Rosetta2 for the first option) and test pyoomph via</p>

<codebox>
<p>python -m pyoomph check all</p>
Expand Down
Loading