mirror of https://github.com/Qiskit/qiskit-aer.git
4b0cddda0b
Cleaning up names and doctrings |
||
---|---|---|
.github | ||
cmake | ||
contrib/standalone | ||
examples | ||
qiskit_aer | ||
src | ||
test | ||
.gitignore | ||
.pylintrc | ||
.travis.yml | ||
CHANGELOG.rst | ||
CMakeLists.txt | ||
LICENSE.txt | ||
MANIFEST.in | ||
README.md | ||
pyproject.toml | ||
requirements-dev.txt | ||
setup.py |
README.md
Qiskit-Aer
This is a working draft for the Qiskit-Aer simulator framework for Qiskit-Terra. This is the development repository and has no guarantee of stability or correctness.
Repository contents
- The qiskit_aer folder contains the Qiskit-Aer python module for use with Qiskit-Terra.
- The cmake folder contains cmake scripts for building the simulator
- The src folder contains the C++ source files for building the simulator.
- The examples folder contains example Jupyter notebooks.
- The contrib folder for external contributions.
- The test folder contains simulator unit tests.
Documentation
There's a contributing guide with more detailed information about the project.
Installation
Follow these steps for installing the Qiskit Aer package:
qiskit-aer$ pip install -r requirements-dev.txt
qiskit-aer$ python ./setup.py bdist_wheel
Once the build finishes, we just need to install the wheel package in our preferred python virtual environment:
qiskit-aer$ pip install dist/qiskit_aer-0.1.0-cp36-cp36m-linux_x86_64.whl
We are all set! Now we ready to start using the simulator in our python code:
import qiskit_aer as aer
from qiskit_aer import Aer # Imports the Aer Provider
Aer.backends() # List Aer backends