Skip to content

Commit b2d2bc6

Browse files
[#0000] Add docs
1 parent b4b4478 commit b2d2bc6

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

docs/source/Install.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,34 @@ versions.
6666
This requires a C++ compiler toolchain and standard build tools
6767
to be installed on your system.
6868

69+
Nightly Builds
70+
--------------
71+
72+
Nightly pre-release wheels are built automatically from the ``develop`` branch and
73+
published to the Basilisk nightly index for all supported platforms. These
74+
builds are replaced each night and reflect the latest state of active development.
75+
They are intended for testing and early access to new features, but may be
76+
unstable and are not recommended for production use.
77+
78+
To install the latest nightly build:
79+
80+
.. code-block:: bash
81+
82+
pip install \
83+
# Use the Basilisk nightly index as the primary source
84+
--index-url https://avslab.github.io/basilisk/nightly/ \
85+
# Allow installing dependencies not found in the nightly index from PyPI
86+
--extra-index-url https://pypi.org/simple/ \
87+
# Required: nightly wheels are pre-release versions
88+
--pre \
89+
bsk
90+
91+
.. warning::
92+
93+
Nightly builds are development snapshots and are not suitable for production use.
94+
For stable releases, install from `PyPI <https://pypi.org/project/bsk/>`_ as described above.
95+
96+
6997
Basilisk Support Data
7098
---------------------
7199

0 commit comments

Comments
 (0)