From 3f9057897ed1ecd4379c5220e8b32d9596c925ef Mon Sep 17 00:00:00 2001 From: Ryan Shaffer Date: Thu, 15 Oct 2020 09:24:12 -0700 Subject: [PATCH] Update docs for Python and Conda packages --- conda-recipes/iqsharp/meta.yaml | 7 ++++++- conda-recipes/qsharp/meta.yaml | 7 ++++++- src/Python/qsharp-core/README.md | 8 +++++++- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/conda-recipes/iqsharp/meta.yaml b/conda-recipes/iqsharp/meta.yaml index 00cf6ab33a..02fc79c9bd 100644 --- a/conda-recipes/iqsharp/meta.yaml +++ b/conda-recipes/iqsharp/meta.yaml @@ -47,5 +47,10 @@ test: about: home: https://docs.microsoft.com/quantum license: MIT - summary: Microsoft's IQ# Server. + summary: Microsoft's IQ# kernel providing Q# support for the Jupyter platform. + description: | + For details on how to get started with Jupyter and Q#, please see the guide at https://docs.microsoft.com/quantum/install-guide/jupyter. + You can also try our Quantum Computing Fundamentals learning path (https://aka.ms/learnqc) to get familiar with the basic concepts + of quantum computing, build quantum programs, and identify the kind of problems that can be solved. dev_url: https://github.com/microsoft/iqsharp + doc_url: https://docs.microsoft.com/quantum/install-guide/jupyter diff --git a/conda-recipes/qsharp/meta.yaml b/conda-recipes/qsharp/meta.yaml index 7885b31b44..f448fb6edf 100644 --- a/conda-recipes/qsharp/meta.yaml +++ b/conda-recipes/qsharp/meta.yaml @@ -42,5 +42,10 @@ test: about: home: https://docs.microsoft.com/quantum license: MIT - summary: Python client for Q#, a domain-specific quantum programming language + summary: Python client for Q#, a domain-specific quantum programming language. + description: | + For details on how to get started with Python and Q#, please see the guide at https://docs.microsoft.com/quantum/install-guide/python. + You can also try our Quantum Computing Fundamentals learning path (https://aka.ms/learnqc) to get familiar with the basic concepts + of quantum computing, build quantum programs, and identify the kind of problems that can be solved. dev_url: https://github.com/microsoft/iqsharp + doc_url: https://docs.microsoft.com/quantum/install-guide/python diff --git a/src/Python/qsharp-core/README.md b/src/Python/qsharp-core/README.md index 2f8afc4f79..8f61360892 100644 --- a/src/Python/qsharp-core/README.md +++ b/src/Python/qsharp-core/README.md @@ -4,6 +4,8 @@ The `qsharp-core` package for Python provides interoperability with the Quantum For details on how to get started with Python and Q#, please see the [Getting Started with Python guide](https://docs.microsoft.com/quantum/install-guide/python). +You can also try our [Quantum Computing Fundamentals](https://aka.ms/learnqc) learning path to get familiar with the basic concepts of quantum computing, build quantum programs, and identify the kind of problems that can be solved. + ## Installing with Anaconda ## If you use Anaconda or Miniconda, installing the `qsharp` package will automatically include all dependencies: @@ -22,7 +24,7 @@ cd iqsharp/src/Python/ python setup.py install ``` -## Building the `qsharp` Package ## +## Building the `qsharp-core` Package ## The Python interoperability feature uses a standard `setuptools`-based packaging strategy. To build a platform-independent wheel, run the setup script with `bdist_wheel` instead: @@ -34,3 +36,7 @@ python setup.py bdist_wheel By default, this will create a `qsharp-core` wheel in `dist/` with the version number set to 0.0.0.1. To provide a more useful version number, set the `PYTHON_VERSION` environment variable before running `setup.py`. + +## Support and Q&A + +If you have questions about the Quantum Development Kit and the Q# language, or if you encounter issues while using any of the components of the kit, you can reach out to the quantum team and the community of users in [Stack Overflow](https://stackoverflow.com/questions/tagged/q%23) and in [Quantum Computing Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/q%23) tagging your questions with **q#**.