|
3 | 3 |
|
4 | 4 | .. _pipInstall: |
5 | 5 |
|
6 | | -Advanced: Building and Installing Pre-Compiled Basilisk Wheels |
7 | | -============================================================== |
| 6 | +Advanced: Building Pre-Compiled Basilisk Wheels |
| 7 | +=============================================== |
8 | 8 |
|
9 | | -.. warning:: |
10 | | - |
11 | | - :beta:`Pip Wheel Support` This method of building Basilisk is currently a beta feature, and should only be attempted by advanced users |
12 | | - familiar with `Python packaging and distribution |
13 | | - <https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/>`_. |
14 | | - This method is not yet guaranteed to work on every platform, and there are still some annoyances |
15 | | - to iron out, but we appreciate any feedback you may have. |
| 9 | +The following instructions explain how to build wheels with Basilisk. |
| 10 | +While we distribute pre-compiled wheels already in :ref:`bskInstall`, |
| 11 | +you can also build them manually using the steps below. This is desirable if |
| 12 | +you want to use Python wheels but still need to enable custom build options |
| 13 | +or link against a custom external module location. |
16 | 14 |
|
17 | | - Most users should see :ref:`configureBuild` for documentation on the regular build process. |
18 | 15 |
|
19 | | - |
20 | | -Building and Installing with ``pip`` |
| 16 | +Building Wheels and Installing with ``pip`` |
21 | 17 | ------------------------------------ |
22 | 18 |
|
23 | 19 | .. note:: |
@@ -49,11 +45,6 @@ After installing |
49 | 45 | Building Basilisk ``wheel`` File |
50 | 46 | -------------------------------- |
51 | 47 |
|
52 | | -On its own, there is no significant benefit to installing Basilisk in this way. However, supporting standard Python |
53 | | -packaging tools means that Basilisk can now be built into a pre-compiled `"wheel" (.whl) file |
54 | | -<https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#wheels>`_ that can be shared |
55 | | -and installed on other compatible machines. |
56 | | - |
57 | 48 | Using ``pip``, the command below will generate a ``Basilisk-*.whl`` file in the current directory:: |
58 | 49 |
|
59 | 50 | pip wheel --no-deps -v . |
|
0 commit comments