Simulating the Schrödinger wave equation using the Crank-Nicolson method in 2+1 dimensions

Repo

Documentation

Requirements

Operating systems

• Linux
  • Has been tested on Fedora 38
  • Will most likely work on other Linux distributions
• macOS
  • Will most likely not work due to the use of getopt, which is GNU specific.
• Windows
  • Will most likely not work

Libraries

• Python

  • matplotlib
  • numpy
  • seaborn

• C++

  • Armadillo

Compiling

The commands shown here should be run from the root of this project.

Normal binaries

Compiling regular binaries is as easy as running this command:

    make

The binaries will then be inside the bin directory.

Debugging binaries

If you want to debug the code, then use this command:

    make debug

The binaries will then be inside the debug directory.

Running programs

C++ binaries

To run any of the programs, just use the following command:

    ./<bin|debug>/<program-name> <args>

If you need help with any of the programs, you can use the -h or --help flag to show you how to use the programs. Here is an example:

    ./bin/main --help

Python scripts

Install libraries

Before running the scripts, make sure that all libraries are installed. Using pip, you can install all requirements like this:

    pip install -r requirements.txt

This recursively install all the packages that are listed in requirements.txt.

Running scripts

For the Python scripts, run them from the root of the project:

    python python_scripts/<script-name>

If you have any problems running the scripts, you might have to run this instead:

    python3 python_scripts/<script-name>

Credits

The Doxygen theme used here is doxygen-awesome-css.