Installation Guide

PAYN requires a specific environment to ensure the reproducibility of scientific results. We strongly recommend using Poetry for dependency management.

1. Prerequisites

Component	Requirement	Notes
OS	Linux / Windows	Slurm is supported on HPC.
Python	3.12	Only tested version at this time.
Manager	Poetry	Used for dependency resolution and virtual environment handling.

2. Installation (Recommended)

Follow these steps to set up the environment using Poetry.

Step 1: Clone the Repository

Retrieve the source code from GitHub.

git clone [https://github.com/GloriusGroup/PAYN.git](https://github.com/GloriusGroup/PAYN.git)
cd PAYN

Step 2: Install Dependencies

Initialize the project. This command reads pyproject.toml, resolves dependency versions, and installs them into an isolated virtual environment.

poetry install

Step 3: Activate Environment

Enter the virtual environment shell to begin working.

poetry shell

---

3. Verification

Before running experiments, verify that the installation is correct and all logic is functioning on your hardware.

Run the Test Suite:

poetry run pytest tests/

Expected Output: You should see a green success bar indicating that all tests (approx. 130) have passed.

===== 130 passed in 67.00s =====

---

4. Troubleshooting

Issue	Solution
poetry: command not found	Ensure Poetry is in your system $PATH. If installed via pip, try python -m poetry ....
Wrong Python Version	Run poetry env use python3.12 to explicitly tell Poetry which executable to use.