The Psi Language

Psi is a functional, general-purpose programming high-level language that abstracts hybrid quantum-classical computing.

---

Table of contents

• 1. Overview
• 2. Documentation
• 3. Development
  • 3.1. Requirements
  • 3.2. Setup
• 4. Appendix
  • 4.1. Packages
  • 4.2. Useful commands
• 5. How to contribute
• 6. License

🔭 1. Overview

^{Back to top ^}

📚 2. Documentation

For full documentation on usage, see here.

^{Back to top ^}

🛠 3. Development

3.1. Requirements

• Rust v1.85.0+
• Make (optional)

^{Back to top ^}

3.2. Setup

1. Install the dependencies and set up the workspace:

$ make

Alternatively, if Make is not installed, use:

./scripts/setup.sh

^{Back to top ^}

📑 4. Appendix

4.1. Packages

Name	Description
compiler	The Psi language compiler.

4.2. Useful commands

Name	Description
cargo build --workspace	Builds all packages to target/release/.
cargo check --workspace	Resolves workspace dependencies.
cargo clippy --workspace	Runs the Rust linter.
cargo fmt --all	Formats all Rust source code.

^{Back to top ^}

👏 5. How to contribute

Please read the contributing guide to learn about the development process.

^{Back to top ^}

📄 6. License

Please refer to the LICENSE file.

^{Back to top ^}