From 5a9d9b16fd18f79d92ed254a4af77b6d9cd9ad72 Mon Sep 17 00:00:00 2001 From: HSilveri Date: Wed, 10 Feb 2021 15:35:52 +0100 Subject: [PATCH 1/3] Changing files for release --- README.md | 45 ++++++++++++++++++++++-------------- docs/source/installation.rst | 11 ++++----- setup.py | 11 ++++----- 3 files changed, 37 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index ceb972a49..aa6c2793a 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,53 @@ # Pulser -A framework for interacting with [Pasqal][pasqal] devices at the **pulse** level. +Pulser is a framework for composing, simulating and executing **pulse** sequences for neutral-atom quantum devices. -Pulser is a library that allows for writing sequences of pulses representing the -behaviour of some Pasqal processor prototypes. -- The user can define one or several channels to target the qubits in the device. -- A basis can be chosen to represent the transition levels of the Rydberg atom-arrays setup. -- Channels can be local or global depending on the application. In the local case, - a phase-shift option is included to reduce complexity -- There's a visualization routine for ease of use. +## Documentation and Installation -The pulse sequences can then be read and operated by real Pasqal devices or -emulated (using [QuTiP][qutip] libraries). +Pulser documentation is available at https://pulser.readthedocs.io. -## Installation +The source code can be found at https://github.com/pasqal-io/Pulser. -To install Pulser from source, do the following from within the repository -after cloning it: +To install the latest release of ``pulser``, have Python 3.7.0 or higher installed, then use ``pip``: + +```bash +pip install pulser +``` + +If you wish to **install Pulser from source** instead, do the following from within this repository after cloning it: ```bash pip install -e . ``` -## Testing +### Development Requirements (Optional) -To run the test suite, after installation first run the following to install -development requirements: +To run the tutorials or the test suite locally, after installation first run the following to install the development requirements: ```bash pip install -r requirements.txt ``` -Then, do the following to run the test suite and report test coverage: +Then, you can do the following to run the test suite and report test coverage: ```bash pytest --cov pulser ``` +## Overview of Pulser + +Pulser is designed to let users create experiments that are tailored to specific neutral atom devices, +like those developed at [Pasqal][pasqal]. +This reduces the level of abstraction and gives you maximal flexibility and control over the behaviour of the relevant physical parameters, within the bounds set by the chosen device. + +Consequently, Pulser breaks free from the paradigm of digital quantum computing +and also allows the creation of **analog** quantum simulations, outside of the +scope of traditional quantum circuit approaches. Whatever the type of experiment +or paradigm, if it can be done on the device, it can be done with Pulser. + +Additionally, Pulser features built-in tools for classical simulation (using [QuTiP][qutip] libraries) to aid in the development and testing of new pulse sequences. + + [pasqal]: https://pasqal.io/ [qutip]: http://qutip.org/ diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 27037bb4d..a5fdd15d1 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,13 +1,12 @@ Installation ============== -.. - Stable version - ----------------- - To install the latest release of ``pulser``, have Python 3.7.0 or higher - installed, then use ``pip``: :: +Stable version +----------------- +To install the latest release of ``pulser``, have Python 3.7.0 or higher +installed, then use ``pip``: :: - pip install pulser + pip install pulser Latest version diff --git a/setup.py b/setup.py index cc9fc04e7..ba4c5be44 100644 --- a/setup.py +++ b/setup.py @@ -16,27 +16,24 @@ setup( name="pulser", - version="0.0.1", + version="0.1.0", install_requires=[ "matplotlib", "numpy", "scipy", + "qutip", ], packages=find_packages(), include_package_data=True, - description="A pulse-level composer for Pasqal's quantum devices.", + description="A pulse-level composer for neutral-atom quantum devices.", long_description=open("README.md").read(), long_description_content_type="text/markdown", author="Pulser Development Team", python_requires=">=3.7.0", license="Apache 2.0", classifiers=[ - "Development Status :: 2 - Pre-Alpha", + "Development Status :: 3 - Alpha", "Programming Language :: Python :: 3", - "Operating System :: MacOS", - "Operating System :: Unix", - "Operating System :: Microsoft :: Windows", - "Topic :: Scientific/Engineering", ], url="https://github.com/pasqal-io/Pulser", ) From f01135442145cc82fc0851538d986aab7dde1467 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrique=20Silv=C3=A9rio?= Date: Wed, 10 Feb 2021 15:38:53 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index aa6c2793a..abf837bb0 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,25 @@ Pulser is a framework for composing, simulating and executing **pulse** sequences for neutral-atom quantum devices. - -## Documentation and Installation - Pulser documentation is available at https://pulser.readthedocs.io. The source code can be found at https://github.com/pasqal-io/Pulser. +## Overview of Pulser + +Pulser is designed to let users create experiments that are tailored to specific neutral atom devices, +like those developed at [Pasqal][pasqal]. +This reduces the level of abstraction and gives you maximal flexibility and control over the behaviour of the relevant physical parameters, within the bounds set by the chosen device. + +Consequently, Pulser breaks free from the paradigm of digital quantum computing +and also allows the creation of **analog** quantum simulations, outside of the +scope of traditional quantum circuit approaches. Whatever the type of experiment +or paradigm, if it can be done on the device, it can be done with Pulser. + +Additionally, Pulser features built-in tools for classical simulation (using [QuTiP][qutip] libraries) to aid in the development and testing of new pulse sequences. + +## Documentation and Installation + To install the latest release of ``pulser``, have Python 3.7.0 or higher installed, then use ``pip``: ```bash @@ -35,19 +47,6 @@ Then, you can do the following to run the test suite and report test coverage: pytest --cov pulser ``` -## Overview of Pulser - -Pulser is designed to let users create experiments that are tailored to specific neutral atom devices, -like those developed at [Pasqal][pasqal]. -This reduces the level of abstraction and gives you maximal flexibility and control over the behaviour of the relevant physical parameters, within the bounds set by the chosen device. - -Consequently, Pulser breaks free from the paradigm of digital quantum computing -and also allows the creation of **analog** quantum simulations, outside of the -scope of traditional quantum circuit approaches. Whatever the type of experiment -or paradigm, if it can be done on the device, it can be done with Pulser. - -Additionally, Pulser features built-in tools for classical simulation (using [QuTiP][qutip] libraries) to aid in the development and testing of new pulse sequences. - [pasqal]: https://pasqal.io/ [qutip]: http://qutip.org/ From cde384b9d05176aa468caed41ef0d00af4b81b24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrique=20Silv=C3=A9rio?= Date: Wed, 10 Feb 2021 15:40:46 +0100 Subject: [PATCH 3/3] Changing README.md structure --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index abf837bb0..daf4ffd17 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ or paradigm, if it can be done on the device, it can be done with Pulser. Additionally, Pulser features built-in tools for classical simulation (using [QuTiP][qutip] libraries) to aid in the development and testing of new pulse sequences. -## Documentation and Installation +## Installation To install the latest release of ``pulser``, have Python 3.7.0 or higher installed, then use ``pip``: