Skip to content

Commit

Permalink
Update windows python installation and configuration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
patkenneally committed Dec 7, 2023
1 parent eb2fd5e commit b399ed6
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions docs/source/Install/installOnWindows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ In order to run Basilisk, the following software will be necessary:
program from the command line
- `Python <https://www.python.org/downloads/windows/>`__ 3.8.x or greater
- `pip <https://pip.pypa.io/en/stable/installing/>`__
- Visual Studios 15 or Greater
- Visual Studios 15 or greater
- `Swig <http://www.swig.org/download.html>`__ version 3 or 4
- (Optional) Get the `GitKraken <https://www.gitkraken.com>`__
application to be able to pull and manage a copy of Basilisk
- (Optional) A GiT GUI application such as `GitKraken <https://www.gitkraken.com>`__
to manage your copy of the Basilisk repository

The following python package dependencies are automatically checked and installed in the steps below.

Expand All @@ -32,11 +32,24 @@ Configuration
Strongly recommended to stick with default 64-bit installations.
Decide whether target deployment is 32 (win32) or 64 (x64) bit. Which ever chosen you will need the matching python and software for that architecture.

Configuring Python
Installing Python
~~~~~~~~~~~~~~~~~~

Python is installed using the Windows installer found on the Python website. Make sure to choose the correct
installer for your architecture.
installer for your architecture. When stepping through the installer there are two menus options menus. The
first is the optional features menu for which all options should be selected.

.. image:: /_images/static/windows-installer-python-optional-features-installer-menu.png
:align: center
:scale: 75%

The second menu is the python advanced options menu where both "Download debugging symbols" and "Download debug binaries
(requires VS 2017 or later)" should be selected in order to build Basilisk with a Debug profile. A Debug profile is
required to place accurate breakpoints/attach a debugger to C/C++ code.

.. image:: /_images/static/windows-installer-python-advanced-options-installer-menu.png
:align: center
:scale: 75%

Install Swig
~~~~~~~~~~~~
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b399ed6

Please sign in to comment.