Skip to content

Commit

Permalink
Add mention of the standalone distribution in docs (capytaine#424)
Browse files Browse the repository at this point in the history
  • Loading branch information
mancellin authored Oct 31, 2023
1 parent b227f73 commit 9e1233d
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/user_manual/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,16 @@ All the core feature of Capytaine are accessible from such a Jupyter-based envir
As a standalone executable
--------------------------

This is a work in progress. See :pull:`324` for progress updates.
An experimental distribution of Capytaine bundled with a full Python distribution in a single executable file can be found at `https://github.com/capytaine/capytaine-standalone`_.
Please refer to the instruction on that page for download and usage.

The standalone executable is the simplest way to use Capytaine locally, although it has some limitations, such a longer startup time and the current lack of interactive Matplotlib figures.

You can check the bundled version of Capytaine with the following command::

.\ipython-with-capytaine-windows.exe -c 'print(cpt.__version__)'

(or the corresponding file name on other platforms than Windows).

Installing with pip package manager
-----------------------------------
Expand Down

0 comments on commit 9e1233d

Please sign in to comment.