This is an automated email from the ASF dual-hosted git repository. rawkintrevo pushed a commit to branch 525 in repository https://gitbox.apache.org/repos/asf/mahout.git
commit f266ea9faf50681049cc3453084c613dc3a4ffb9 Author: bottrevo <[email protected]> AuthorDate: Mon Mar 24 19:14:48 2025 +0000 Add getting_started_with_qumat.md --- docs/getting_started_with_qumat.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/getting_started_with_qumat.md b/docs/getting_started_with_qumat.md new file mode 100644 index 000000000..fa4dfd6ff --- /dev/null +++ b/docs/getting_started_with_qumat.md @@ -0,0 +1,36 @@ +# Getting Started with Qumat + +## Installation + +To install Qumat, you can either clone the repository and install it locally or install it directly using pip. + +### Option 1: Clone from Source + +``` +git clone https://github.com/apache/mahout +cd mahout +pip install . +``` + +### Option 2: Install via pip + +``` +pip install git+https://github.com/apache/mahout +``` + +## Dependencies + +Before installation, ensure you have Python 3.10 installed on your system. Other dependencies such as `qiskit`, `qiskit-aer`, `cirq`, `amazon-braket-sdk`, and `sympy` should be automatically handled by pip. + +## Filled from Source + +When installing from source, use the following commands to clone the repository: + +``` +git clone https://github.com/apache/mahout +cd mahout +``` + +## Example Notebooks + +For getting started with some basic commands and examples, refer to the example notebooks available in the repository. A simple example can be found in `examples/Simple_Example.ipynb`, which demonstrates how to create quantum circuits using the Qumat library. The notebook can be opened in Google Colab using the link provided in the notebook header. \ No newline at end of file
