Home - Schumacher-Group-UPB/PHOENIX GitHub Wiki

Welcome to the PHOENIX Wiki!

PHOENIX is a command-line program designed to simulate polariton condensates using the two-dimensional Schrödinger equation. It offers high-performance simulation capabilities, leveraging both GPU and CPU resources. Whether you're a researcher, student, or enthusiast, PHOENIX provides robust tools for exploring complex quantum phenomena.

Getting Started with PHOENIX

  1. Install Dependencies
    Ensure you have a working CUDA installation. Refer to the Preparation for Building PHOENIX section for guidance on setting up CUDA. Additional dependencies such as SFML (for rendering) or FFTW (for CPU-only versions) may be required depending on your configuration.

  2. Download PHOENIX
    Visit the releases page to download a version suitable for your system. Options include:

    • GPU Support: Builds with CUDA acceleration (_gpu_).
    • CPU Support: Builds optimized for CPU-only computation (_cpu_).
    • Single Precision: Faster computations with 32-bit floating point (_fp32).
    • Double Precision: Higher accuracy with 64-bit floating point (_fp64).
    • SFML Support: Builds with live rendering capabilities (_sfml_), requiring a working SFML installation.

  3. Test PHOENIX
    Open a terminal in the program's directory and run:

    phoenix.exe[.o] --help

    This displays a summary of available command-line options, providing an overview of PHOENIX's functionalities.

Building PHOENIX Manually

For users who prefer to build PHOENIX from source, follow these steps:

  1. Install Git
    Refer to Installing Git for guidance on setting up Git for cloning the repository.

  2. Prepare Your System
    Ensure CUDA is installed and properly configured. Detailed instructions can be found in the Preparation for Building PHOENIX section.

  3. Optional: Install SFML
    If you plan to use live rendering, install SFML as described in SFML Rendering.

  4. Build PHOENIX
    Follow the instructions in Building PHOENIX to compile the program. This includes steps for configuring the Makefile and building for GPU, CPU, and optional features like SFML rendering.

For additional guidance and troubleshooting, explore the other sections of the wiki or check the examples folder for use cases and configurations. PHOENIX is a powerful tool, and we’re here to help you get the most out of it!