Penning trap simulation

Repo

Documentation

Requirements

Operating systems

• Linux
  • Has been tested on Fedora 38
  • Will most likely work on other Linux distributions
• MacOS
  • Might work, but hasn't been tested
• Windows
  • Will most likely not work

Libraries

• Python
  • matplotlib
  • numpy
• C++
  • openmp
  • armadillo

Compiling

Compiling is as easy as running this command while being inside the src directory:

make

Running programs

C++ binaries

To run main or test_suite, just run this command while being inside src:

./<program-name>

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 src directory like this:

python scripts/<script-name>

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

python3 scripts/<script-name>

Credits

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