Python Interface

Instructions how to install the CSXCAD & openEMS Python interface. update_openEMS.sh --python does this for you; the automatic page covers its options, the manual page is for building the extensions by hand.

• Install Python Extensions Automatically
  • Quick Start
  • Customize Install
    • Arguments
  • Typical Customization Cases
    • Q: I don’t want update_openEMS.sh to create a new venv for me, because I have my own.
    • Q: I want to create a new venv, but not under the /venv subdirectory of openEMS.
    • Q: All system packages are invisible in the Python venv. I don’t want to reinstall them via pip3 for the venv, I want to use the existing system Python packages.
    • Q: I don’t want ./update_openEMS.sh to download dependencies using pip3 because I don’t have Internet access.
    • Q: I don’t want to use pip3 to manage Python package dependencies, I want to use my system’s own package manager.
    • Q: I have Internet access, but behind a proxy.
    • Q: I don’t want to use a Python venv at all, I want to install Python extensions to the default paths, which is the legacy behavior in previous openEMS versions.
    • Q: I’m debugging ./update_openEMS.sh --python, but the Python errors are incomprehensible
    • Q: ./update_openEMS.sh is a black box, I need explicit control over the installation.
• Install Python Extensions Manually
  • Requirements
    • Python version
    • Other Dependencies
  • Quick Start
  • Environment Variables
  • Basic Install
    • Step 1: Set CSXCAD_INSTALL_PATH and OPENEMS_INSTALL_PATH
    • Step 2: venv
    • Step 3: pip
  • Offline Install or Manual Package Management
    • Install Dependencies
    • Expose System Packages to venv
    • Disable Build Isolation
      • Override CSXCAD_PYSRC_PATH
  • Advanced Install Concepts
    • Suppress RuntimeError
    • Search Path Management
    • Expose System Packages in venv
    • Install Python Extension to Home Directory Instead of venv
    • Legacy Installation via setup.py
      • Advanced: setup.py search path management
  • Windows
    • Step 1: Download the package
    • Step 2: Install the wheels
    • Step 3: Set CSXCAD_INSTALL_PATH
    • Step 4: Verify the installation
    • Build Modules From Source
  • Troubleshooting
    • ImportError: DLL load failed while importing CSXCAD (Windows)
    • AttributeError: module ‘CSXCAD.CSRectGrid’ has no attribute…
    • FileNotFoundError: [Errno 2] No such file or directory: /CSXCAD/python
    • Unable to detect CSXCAD’s Python source code path
    • ModuleNotFoundError: No module named ‘CSXCAD.CSXCAD’
    • ModuleNotFoundError: No module named ‘openEMS.openEMS’
    • error: invalid command ‘bdist_wheel’
  • CSXCAD Tests and Examples