-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs/macos_install] Adding install instructions for MacOS to docs an…
…d readme
- Loading branch information
1 parent
e9c0e48
commit 6fbae0a
Showing
2 changed files
with
41 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,6 +28,14 @@ Installation | |
============ | ||
In order to get started, we'll need to install the package and its dependencies. | ||
|
||
Requirements | ||
------------ | ||
- `CMake <https://pypi.org/project/cmake/>`_ >= 3.25 | ||
- `Ninja <https://pypi.org/project/ninja/>`_ >= 1.11 | ||
- C++ compiler with OpenMP and C++20 support (`LLVM <https://apt.llvm.org/>`_ recommended) | ||
- `Python <https://www.python.org/downloads/>`_ >= 3.10 | ||
- `scikit-build-core <https://pypi.org/project/scikit-build-core/>`_ (ONLY for building from source with custom configuration) | ||
|
||
In the following subsections, we describe several options for installing ``fast_pauli``. | ||
|
||
Install the Latest Release | ||
|
@@ -36,14 +44,24 @@ Install the Latest Release | |
pip install fast_pauli | ||
Build from Source (Default Config) | ||
Build from Source (Linux) | ||
----------------------------------------- | ||
.. code-block:: bash | ||
git clone [email protected]:qognitive/fast-pauli.git | ||
cd fast_pauli | ||
python -m pip install -e ".[dev]" | ||
Build from Source (MacOS) | ||
----------------------------------------- | ||
.. code-block:: bash | ||
git clone [email protected]:qognitive/fast-pauli.git | ||
cd fast_pauli | ||
python -m pip install --upgrade pip | ||
python -m pip install scikit-build-core | ||
brew install llvm | ||
pip install -e . -C cmake.args="-DCMAKE_CXX_COMPILER=$(brew --prefix llvm)/bin/clang++;-DCMAKE_CXX_FLAGS='-stdlib=libc++ -fexperimental-library'" | ||
Build from Source (Custom Config) | ||
--------------------------------- | ||
|