Skip to content

Commit 8f8536d

Browse files
ReeceHumphreysschaubh
authored andcommitted
Add new pip install instructions
1 parent e34c858 commit 8f8536d

File tree

5 files changed

+24
-20
lines changed

5 files changed

+24
-20
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,8 @@ lib/*
6565
build/
6666
!.github/actions/build/
6767
!.github/actions/build/**
68+
69+
# Documentation
70+
!docs/source/Build/
71+
6872
*.git-template

docs/source/Build.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
1-
Build
2-
=====
1+
Building from Source
2+
====================
3+
4+
.. _bskInstall-build:
5+
6+
For advanced users and developers who want to customize or debug Basilisk. For
7+
most users the precompiled version available on PyPI is sufficient. See the
8+
:ref:`Install Instructions <bskInstall>` for more information.
9+
10+
.. note::
11+
To use custom C++ modules, Basilisk must be built from source.
12+
The prebuilt PyPI wheels are designed for most users and include all standard
13+
features, but they do not yet support linking external C++ modules.
14+
We're actively exploring ways to enable this in future releases.
315

416
.. toctree::
517
:maxdepth: 1
618
:caption: Contents:
719

8-
Build/customPython
920
Build/pullCloneBSK
1021
Build/installOnLinux
1122
Build/installOnMacOS
1223
Build/installOnWindows
1324
Build/installBuild
1425
Build/buildExtModules
26+
Build/customPython
1527
Build/installBuildConan
1628
Build/pipInstall

docs/source/Build/pipInstall.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,22 +49,15 @@ After installing
4949
Building Basilisk ``wheel`` File
5050
--------------------------------
5151

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-
Using ``pip``, the command below will generate a ``Basilisk-*.whl`` file in the current directory::
52+
Using ``pip``, the command below will generate a ``bsk-*.whl`` file in the current directory::
5853

5954
pip wheel --no-deps -v .
6055

6156
The resulting wheel file can then be installed using ``pip``::
6257

63-
pip install Basilisk-*.whl
58+
pip install bsk-*.whl
6459

65-
The main benefit of this approach will come in the future, when a set of pre-compiled wheels will be made available,
66-
allowing most users to easily ``pip install Basilisk`` without compilation, in the same way that packages like
67-
``numpy``, ``scipy``, and ``pandas`` are available.
60+
This allows the user to create a custom Basilisk wheel to distribute within their organization.
6861

6962
To keep the wheel size smaller, the BSK data files are not installed by default. If the user
7063
wants to use script that assumes they are included into the Basilisk python package, then go to the
@@ -83,7 +76,7 @@ directly downloads the missing BSK data files and put them into a local pooch ca
8376
If the computer does not have local internet access and the ``pip install`` is done via
8477
a local wheel, then these missing Spice ``*.bsp`` data files can be manually added to::
8578

86-
.../.venv/lib/python3.11/site-packages/Basilisk/supportData/EphemerisData
79+
.venv/lib/python3.11/site-packages/Basilisk/supportData/EphemerisData
8780

8881
If installing Basilisk via a wheel the user does not have direct access to the full Basilisk source
8982
folder which contains the ``examples`` folder. The Terminal command ``bskExamples``

docs/source/Install.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
.. Basilisk documentation master file, created by
2-
sphinx-quickstart on Mon Sep 23 13:52:19 2019.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
61
.. _bskInstall:
72

83
Install

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Related Publications
203203
:includehidden:
204204

205205
Install
206-
Build
206+
Building from Source <Build>
207207
Learn
208208
Support
209209
Documentation/index

0 commit comments

Comments
 (0)