Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate qdk.chemistry and rewrite README #515

Merged
merged 7 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
If you would like to become an active contributor to this project please
follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](https://opensource.microsoft.com/collaborate/).

## Pre-requisites

Install pre-reqs:

```bash
pip install azure_devtools pytest pytest-azurepipelines pytest-cov
```

kikomiss marked this conversation as resolved.
Show resolved Hide resolved
## Building and testing ##

The Azure Quantum team uses [Anaconda](https://www.anaconda.com/products/individual) to create virtual environments for local unit and integration testing as well as in CI/CD.
Expand Down
58 changes: 10 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,33 @@
[![Build Status](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_apis/build/status/microsoft.qdk-python?branchName=main)](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_build/latest?definitionId=32&branchName=main)

# QDK-Python
# Azure Quantum SDK

## Introduction

QDK-Python is the repository for Python packages of the Quantum Development Kit (QDK). Currently, this consists of the following packages:
This repository contains the azure-quantum Python SDK.

Use azure-quantum SDK to submit quantum jobs written in Q#, Qiskit, or Cirq to the Azure Quantum service:

- `qdk` [![PyPI version](https://badge.fury.io/py/qdk.svg)](https://badge.fury.io/py/qdk)
- `azure-quantum` [![PyPI version](https://badge.fury.io/py/azure-quantum.svg)](https://badge.fury.io/py/azure-quantum)

Coming soon:
Deprecated:

- qsharp
- `qdk` [![PyPI version](https://badge.fury.io/py/qdk.svg)](https://badge.fury.io/py/qdk)
- Contains the qdk.chemistry packages.

## Installation and getting started

To install the packages, we recommend installing the Anaconda Python distribution. For instructions on installing Conda on your system, please follow the [Conda user guide](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html).

To install the QDK package, run

```bash
pip install qdk
```

To install the Azure Quantum package, run
To install the Azure Quantum package, run:

```bash
pip install azure-quantum
```

To get started running examples, start a Jupyter notebook:

```bash
cd examples
jupyter notebook
```
To get started and submit your first job, see the official [Azure Quantum documentation](https://learn.microsoft.com/azure/quantum/quickstart-microsoft-qiskit-portal?pivots=platform-ionq).

## Development

Install pre-reqs:

```bash
pip install azure_devtools pytest pytest-azurepipelines pytest-cov
```

To create a new Conda environment, run:

```bash
conda env create -f environment.yml
```

in the root directory of the given package (`qdk` or `azure-quantum`).

Then to activate the environment:

```bash
conda activate <env name>
```

where `<env name>` is the environment name (`qdk` or `azurequantum`).

To install the package in development mode, run:

```bash
pip install -e .
```
See [CONTRIBUTING](./CONTRIBUTING.md) for instructions on how to build and test.

## Contributing

Expand All @@ -86,7 +49,6 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio

While we encourage contributions in any part of the code, there are some exceptions to take into account.
- The package `azure.quantum._client` is autogenerated using the [Azure Quantum Swagger spec](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/quantum/data-plane). No manual changes to this code are accepted (because they will be lost next time we regenerate the client).
- The package `qdk.chemistry._xyz2mol` is maintained [here](https://github.com/jensengroup/xyz2mol) and included as a vendor package in this repo. Please make any suggestions or improvements to the code there.

## Trademarks

Expand Down
853 changes: 0 additions & 853 deletions examples/chemistry/Molecule.ipynb

This file was deleted.

Loading