User Manual

Once installed and tested by following the instructions at Installation, plasmonX can be run with:

PATH_TO_BUILD/plasmonX.py [-h] -i input_file.yaml [-o output_file] [-omp omp_threads] [-mem memory_available] [-v]

The plasmonX.py script supports the following options:

Option

Required

Description

-i

Mandatory

Input file: YAML format with .yaml extension

-o

Optional

Output file. Default: input_file.log

-omp

Optional

Number of OpenMP threads. Default: Max available

-mem

Optional

Memory in GB. Default: Max available

-v

Optional

Print the version and compilation information

-h

Optional

Print the help message

Additional information is available in the following sections:

  • Input File How to structure the YAML input file and define simulation parameters.

  • Output Files Details about the output file generated by plasmonX.

  • Post-Processing Guide How to analyze and visualize results using plasmonX_analysis.