Nuclear Quantum computing Library

Features

Nuclear Quantum computing Library (NuQlib) provides a set of tools for quantum simulations of nuclear systems. One of the main motivations to develop NuQuLib was to provide a library for quantum computing that can be used in conjunction with existing nuclear physics codes.

One can use some interaction formats adopted in e.g. NuHamil and KSHELL, and try a subspace method called QSCI (a.k.a. SQD) through NuclearToolkit.jl.

Installation

A recommended environment to set up the dependencies and run NuQuLib is one like uv, which is a tool for managing Python virtual environments and dependencies. You can create a new environment and install the dependencies using the following commands:

uv init --package your_project

Then you will get directory structure like this:

your_project/
├── .git
├── .gitignore
├── .python-version
├── pyproject.toml
├── README.md
└── src

In the root directory of NuQuLib (or your project), you can install the dependencies using the following command:

uv sync

If you are using pip, you may install the dependencies using the following command:

pip install -e /path/to/nuqulib

However, compatibility with pip is not guaranteed, and we recommend using uv instead.

When a GPU is available, you need to remove qiskit-aer installed by default and install qiskit-aer-gpu instead.

Tutorials

A tutorial notebook is available at here.

API Reference

Please refer to API reference for NuQuLib for detailed API reference.