Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
msoeken committed Oct 9, 2023
1 parent 4d6f7f7 commit 183c24d
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions azure-quantum/examples/resource_estimation/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# Resource estimator examples

This directory contains several standalone Python scripts that use the Azure
Quantum Resource Estimator through the `azure_quantum` Python API.
Quantum Resource Estimator through the `azure-quantum` Python API.

## Example scripts
## Prerequisites

These scripts require access to an Azure Quantum workspace. Read [our
documentation](https://learn.microsoft.com/azure/quantum/how-to-create-workspace?tabs=payg%2Ctabid-quick)
to learn how to set up an Azure Quantum workspace. Once the Azure Quantum
workspace is created, you can retrieve the _resource id_ and _location_ from
the _Overview_ page of your workspace.

Also, you need to install the `azure-quantum` Python package:

Some of the scripts require a resource id and a location, which can be obtained
from the _Overview_ page of your _Azure Quantum workspace_.
```shell
python -m pip install azure-quantum
```

## Example scripts

* **[cli.py](https://github.com/microsoft/qdk-python/blob/main/azure-quantum/examples/resource_estimation/cli.py): A resource estimation CLI that can execute resource
estimation jobs from various input formats and generate JSON output.**
Expand Down

0 comments on commit 183c24d

Please sign in to comment.