From acef927f99a9f8e617f4f16994da989236f3ce11 Mon Sep 17 00:00:00 2001 From: Gabriel Ferreira Date: Mon, 11 Sep 2023 18:53:11 -0300 Subject: [PATCH] docs: Update Python bindings docs regarding incompatibility with ARM-based Macs --- doc/installation/source/macos.rst | 2 ++ doc/installation/source/system.rst | 2 ++ doc/manual/source/python.rst | 6 +----- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/installation/source/macos.rst b/doc/installation/source/macos.rst index 918671b13..2b241f85d 100644 --- a/doc/installation/source/macos.rst +++ b/doc/installation/source/macos.rst @@ -38,6 +38,8 @@ of Python, please keep the possibility of a virtualenv in mind if you run into P For a short guide on virtual environments, please see `this link `_. +Due to an `upstream limitation with Cppyy `_, Python bindings do not work on macOS machines with Apple silicon (M1 and M2 processors). + Requirements ************ diff --git a/doc/installation/source/system.rst b/doc/installation/source/system.rst index a458d6510..1641022ac 100644 --- a/doc/installation/source/system.rst +++ b/doc/installation/source/system.rst @@ -143,6 +143,8 @@ Python bindings (ns-3.37 and newer) |ns3| Python support now uses `cppyy `_. Version 2.4.2 is the most recent supported cppyy release; version 3.0.0 is not currently supported. +Due to an `upstream limitation with cppyy `_, Python bindings do not work on macOS machines with Apple silicon (M1 and M2 processors). + Using Python bindings (release 3.30 to ns-3.36) =============================================== diff --git a/doc/manual/source/python.rst b/doc/manual/source/python.rst index 6ad5ec803..38dbf57ae 100644 --- a/doc/manual/source/python.rst +++ b/doc/manual/source/python.rst @@ -38,11 +38,7 @@ If a user is not interested in Python, no action is needed; the Python bindings are only built on-demand by Cppyy, and only if the user enables them in the configuration of |ns3|. -It is also important to note that the current capability is provided on a -lightly maintained basis and not officially supported by the project -(in other words, we are currently looking for a Python bindings maintainer). -The Cppyy framework could be replaced if it becomes too burdensome to -maintain as we are presently doing. +Due to an `upstream limitation with Cppyy `_, Python bindings do not work on macOS machines with Apple silicon (M1 and M2 processors). Prior to ns-3.37, the previous Python bindings framework was based on `Pybindgen `_.