The "Point To Point Python" library is a Python implementation of "Point To Point LT" for modeling analog circuits. It is intended for audio signal processing applications. Component-level circuit analysis is automated, allowing for arbitrary circuits to be easily implemented based on the available components.

This software is for educational and personal use only. It may not be used in commercial products without the prior written consent of Hack Audio LLC. By using this software, you are agreeing to the license terms in LICENSE.

PointToPoint_Python/
├── include/circuits/          # C++ header files for circuit definitions
├── python/
│   ├── bindings/             # pybind11 binding code
│   └── PointToPoint/         # Python package
├── examples/                  # Example scripts and notebooks
├── scripts/                   # Build and utility scripts
├── lib/pybind11/             # pybind11 submodule
├── PointToPoint_SDK/         # Point To Point SDK library
├── userXML/                  # User-provided XML circuit definitions
└── build/                    # Build output (generated)

• Ensure you have CMake (version 3.5 to 3.28) installed on your system. https://cliutils.gitlab.io/modern-cmake/chapters/intro/installing.html
• It is reccommended that you run build within a virtual environment like miniconda or another python virtual environment. You can find the installation instructions for miniconda here: https://docs.anaconda.com/miniconda/miniconda-install/
  • miniconda:
    • In your terminal, run conda create --name <my-env> -f requirements.txt. Replace <my-env> with the name of your environment. Make sure that you are in the PointToPoint_Python directory so you have access to requirements.txt.
    • To activate your new environment use conda activate <my-env>, again replacing <my-env> with the name of your new environment.
  • Python Virtual Environment:
    • Make sure you are using Python version 3.3 or later. You can install a modern version of Python here: https://realpython.com/installing-python/
    • Run python3 -m venv venv/ to create your virtual environment.
    • Activate the virtual environment using source venv/bin/activate.
    • Install packages using source venv/bin/activate.
    • You can deactivate your virtual environment using deactivate.

• Add your XML file to userXML directory.
• Run python3 scripts/importXML.py insert/your/file/path/to/xml/here.
• Make sure to run this for each of your XML files individually.
• Run python3 scripts/generateBindingFromHeader.py include/circuits/UserCircuits.h.
• Run python3 scripts/build.py to run the build script.
• That's it! You're done!

• Add the full path to your build directory where instructed.
• Import circuits you would like to use by following the examples.
• Change the effect variable to match your imported circuit.
• Run all cells.

This software is licensed under a proprietary source code license agreement. For complete terms and conditions, see LICENSE.

Summary:

• For educational and personal use only
• Commercial use requires written consent from Hack Audio LLC
• No distribution of software without approval
• Provided "as is" without warranties

Copyright (c) Hack Audio LLC