Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update mac instructions #161

Merged
merged 2 commits into from
Sep 24, 2024
Merged

Update mac instructions #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
584cdad
more python docs
ryanmrichard Sep 24, 2024
a8b2f1a
add picture
ryanmrichard Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/coding/ides/vscode/assets/mac_setup/missing_python_headers.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/source/coding/ides/vscode/setup_mac.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,16 @@ Troubleshooting
- If the configuration fails because of a missing dependency (e.g.,
MPI or Boost) consult :ref:`obtaining_dependencies_on_macos`.

- If the configuration fails because of the missing Python developer files,
e.g.,

.. figure:: assets/mac_setup/missing_python_headers.png
:align: center

CMake could not locate the Python header files.

consult :ref:`obtaining_dependencies_on_macos`.

Building and Testing
====================

Expand Down
7 changes: 7 additions & 0 deletions docs/source/coding/preliminaries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,19 @@ Installing Dependencies

With Homebrew the dependencies and corresponding terminal commands are:

- python3
- git ``brew install git``.
- C and C++ compilers (MacOS comes with ``clang`` and ``clang++``)
- CMake ``brew install cmake``.
- MPI ``brew install mpich``.
- Boost ``brew install boost``.

.. note::

To find the Python developer libraries run ``python3-config --include``.
Add the output of this command (without the ``-I``) to the CMake variables:
``Python_INCLUDE_DIRS`` and ``Python3_INCLUDE_DIRS``.

*******************
Directory Structure
*******************
Expand Down
Loading