Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.34 KB

README.md

File metadata and controls

63 lines (43 loc) · 2.34 KB
Raw

Qadence-Libs

Qadence-Libs is a Python package that provides extra functionality for Qadence.

Linting Tests Documentation Pypi License

Installation guide

PyPI and can be installed using pip as follows:

pip install qadence_libs

Contributing

Before making a contribution, please review our code of conduct.

  • Submitting Issues: To submit bug reports or feature requests, please use our issue tracker.
  • Developing in qadence: To learn more about how to develop within qadence, please refer to contributing guidelines.

Setting up qadence in development mode

We recommend to use the hatch environment manager to install qadence_libs from source:

python -m pip install hatch

# get into a shell with all the dependencies
python -m hatch shell

# run a command within the virtual environment with all the dependencies
python -m hatch run python my_script.py

WARNING hatch will not combine nicely with other environment managers such as Conda. If you still want to use Conda, install it from source using pip:

# within the Conda environment
python -m pip install -e .

Citation

If you use Qadence-Libs for a publication, we kindly ask you to cite our work using the following BibTex entry:

@misc{qadence-libs2024pasqal,
  url = {https://github.com/pasqal-io/qadence-libs},
  title = {Qadence Libs: {A}n {E}xperiment runner for Qadence.},
  year = {2023}
}

License

Qadence-Libs is a free and open source software package, released under the Apache License, Version 2.0.