Prerequisites

To download and use plasmonX correctly, the repository must be cloned using Git over SSH.

This is necessary because the code includes git submodules, which are not present if the repository is downloaded as a .zip or .tar.gz archive from the GitHub interface. Without the submodules, certain parts of the codebase will not be available.

If you do not have a GitHub account, you need to create one at:

https://github.com

Once you have an account, you need to generate an SSH key and add it to your GitHub profile.

The full instructions for generating an SSH key and adding it to your GitHub account are available at:

https://docs.github.com/en/authentication/connecting-to-github-with-ssh

Verify that the SSH key has been correctly added:

ssh -T git@github.com

Once completed, please proceed with Installation.