From 61d76654a297221e84bd899e8a9d9fef05b0afc4 Mon Sep 17 00:00:00 2001 From: HGSilveri Date: Fri, 23 Sep 2022 11:19:13 +0200 Subject: [PATCH 1/3] Create the pulser-pasqal package --- .coveragerc | 1 + .gitignore | 4 +- .mypy.ini | 6 +- .readthedocs.yml | 1 + packages.txt | 3 +- pulser-pasqal/LICENSE | 202 ++++++++++++++++++++++++ pulser-pasqal/MANIFEST.in | 2 + pulser-pasqal/README.md | 21 +++ pulser-pasqal/pulser_pasqal/__init__.py | 16 ++ pulser-pasqal/pulser_pasqal/_version.py | 20 +++ pulser-pasqal/pulser_pasqal/py.typed | 0 pulser-pasqal/requirements.txt | 1 + pulser-pasqal/rtd_requirements.txt | 1 + pulser-pasqal/setup.py | 70 ++++++++ pyproject.toml | 2 +- 15 files changed, 344 insertions(+), 6 deletions(-) create mode 100644 pulser-pasqal/LICENSE create mode 100644 pulser-pasqal/MANIFEST.in create mode 100644 pulser-pasqal/README.md create mode 100644 pulser-pasqal/pulser_pasqal/__init__.py create mode 100644 pulser-pasqal/pulser_pasqal/_version.py create mode 100644 pulser-pasqal/pulser_pasqal/py.typed create mode 100644 pulser-pasqal/requirements.txt create mode 100644 pulser-pasqal/rtd_requirements.txt create mode 100644 pulser-pasqal/setup.py diff --git a/.coveragerc b/.coveragerc index 5fe460104..b72f6846e 100644 --- a/.coveragerc +++ b/.coveragerc @@ -18,3 +18,4 @@ show_missing = True source = pulser-core/pulser/ pulser-simulation/pulser_simulation/ + pulser-pasqal/pulser_pasqal/ diff --git a/.gitignore b/.gitignore index 6238e047a..3225aac88 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,4 @@ build/ docs/build/ dist/ env* -pulser.egg-info/ -pulser_simulation.egg-info/ -pulser_core.egg-info/ +*.egg-info/ diff --git a/.mypy.ini b/.mypy.ini index 62caff8ae..55e678547 100644 --- a/.mypy.ini +++ b/.mypy.ini @@ -1,5 +1,9 @@ [mypy] -files = pulser-core/pulser, pulser-simulation/pulser_simulation, tests +files = + pulser-core/pulser, + pulser-simulation/pulser_simulation, + pulser-pasqal/pulser_pasqal, + tests python_version = 3.8 warn_return_any = True warn_redundant_casts = True diff --git a/.readthedocs.yml b/.readthedocs.yml index 61cab3a91..2f39de3cd 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -21,3 +21,4 @@ python: - requirements: dev_requirements.txt - requirements: pulser-core/rtd_requirements.txt - requirements: pulser-simulation/rtd_requirements.txt + - requirements: pulser-pasqal/rtd_requirements.txt diff --git a/packages.txt b/packages.txt index 888e92d31..c76983836 100644 --- a/packages.txt +++ b/packages.txt @@ -1,2 +1,3 @@ pulser-core -pulser-simulation \ No newline at end of file +pulser-simulation +pulser-pasqal \ No newline at end of file diff --git a/pulser-pasqal/LICENSE b/pulser-pasqal/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/pulser-pasqal/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/pulser-pasqal/MANIFEST.in b/pulser-pasqal/MANIFEST.in new file mode 100644 index 000000000..04f196ac7 --- /dev/null +++ b/pulser-pasqal/MANIFEST.in @@ -0,0 +1,2 @@ +include README.md +include LICENSE diff --git a/pulser-pasqal/README.md b/pulser-pasqal/README.md new file mode 100644 index 000000000..bdf46c2a2 --- /dev/null +++ b/pulser-pasqal/README.md @@ -0,0 +1,21 @@ +# pulser-pasqal + +[Pulser](https://pypi.org/project/pulser/) is a framework for composing, simulating and executing **pulse** sequences for neutral-atom quantum devices. + +This is the `pulser-pasqal` extension, which provides the functionalities needed to execute `pulser` sequences on [Pasqal](https://pasqal.io/)'s backends. + +## Installation + +The standard Pulser installation, + +```bash +pip install pulser +``` + +will automatically install `pulser-pasqal`. If you wish to install it on its own, you can also run + +```bash +pip install pulser-pasqal +``` + +Note that `pulser-core` is a requirement of `pulser-pasqal`, so it will be installed if it hasn't been already. diff --git a/pulser-pasqal/pulser_pasqal/__init__.py b/pulser-pasqal/pulser_pasqal/__init__.py new file mode 100644 index 000000000..32f069f21 --- /dev/null +++ b/pulser-pasqal/pulser_pasqal/__init__.py @@ -0,0 +1,16 @@ +# Copyright 2022 Pulser Development Team +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Classes for interfacing with Pasqal backends.""" + +from pulser_pasqal._version import __version__ diff --git a/pulser-pasqal/pulser_pasqal/_version.py b/pulser-pasqal/pulser_pasqal/_version.py new file mode 100644 index 000000000..08126f2ae --- /dev/null +++ b/pulser-pasqal/pulser_pasqal/_version.py @@ -0,0 +1,20 @@ +# Copyright 2022 Pulser Development Team +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +from pathlib import PurePath + +# Sets the version to the same as 'pulser'. +version_file_path = PurePath(__file__).parent.parent.parent / "VERSION.txt" + +with open(version_file_path, "r") as f: + __version__ = f.read().strip() diff --git a/pulser-pasqal/pulser_pasqal/py.typed b/pulser-pasqal/pulser_pasqal/py.typed new file mode 100644 index 000000000..e69de29bb diff --git a/pulser-pasqal/requirements.txt b/pulser-pasqal/requirements.txt new file mode 100644 index 000000000..71ce7bb74 --- /dev/null +++ b/pulser-pasqal/requirements.txt @@ -0,0 +1 @@ +pasqal-sdk diff --git a/pulser-pasqal/rtd_requirements.txt b/pulser-pasqal/rtd_requirements.txt new file mode 100644 index 000000000..6d5a1ae77 --- /dev/null +++ b/pulser-pasqal/rtd_requirements.txt @@ -0,0 +1 @@ +pulser-pasqal/. diff --git a/pulser-pasqal/setup.py b/pulser-pasqal/setup.py new file mode 100644 index 000000000..8629b4de0 --- /dev/null +++ b/pulser-pasqal/setup.py @@ -0,0 +1,70 @@ +# Copyright 2022 Pulser Development Team +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import os +from pathlib import Path + +from setuptools import find_packages, setup + +distribution_name = "pulser-pasqal" # The name on PyPI +package_name = "pulser_pasqal" # The main module name +description = ( + "A Pulser extension to execute pulse-level sequences on Pasqal" + " backends." +) +current_directory = Path(__file__).parent + +# Reads the version from the VERSION.txt file +with open(current_directory.parent / "VERSION.txt", "r") as f: + __version__ = f.read().strip() + +# Changes to the directory where setup.py is +os.chdir(current_directory) + +with open("requirements.txt") as f: + requirements = f.read().splitlines() +requirements.append(f"pulser-core=={__version__}") + +# Stashes the source code for the local version file +local_version_fpath = Path(package_name) / "_version.py" +with open(local_version_fpath, "r") as f: + stashed_version_source = f.read() + +# Overwrites the _version.py for the source distribution (reverted at the end) +with open(local_version_fpath, "w") as f: + f.write(f"__version__ = '{__version__}'\n") + +setup( + name=distribution_name, + version=__version__, + install_requires=requirements, + packages=find_packages(), + package_data={package_name: ["py.typed"]}, + include_package_data=True, + description=description, + 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 :: 3 - Alpha", + "Programming Language :: Python :: 3", + ], + url="https://github.com/pasqal-io/Pulser", + zip_safe=False, +) + +# Restores the original source code of _version.py +with open(local_version_fpath, "w") as f: + f.write(stashed_version_source) diff --git a/pyproject.toml b/pyproject.toml index c0f15345a..7db90a088 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,4 +4,4 @@ line-length = 79 [tool.isort] profile = "black" line_length = 79 -src_paths = ["pulser-core", "pulser-simulation"] +src_paths = ["pulser-core", "pulser-simulation", "pulser-pasqal"] From 804185019b7222a7f9e290b5b335536fda242600 Mon Sep 17 00:00:00 2001 From: HGSilveri Date: Fri, 23 Sep 2022 12:04:32 +0200 Subject: [PATCH 2/3] Adding makefile for the development install --- .github/workflows/pulser-setup/action.yml | 2 +- Makefile | 14 ++++++++++++++ README.md | 2 +- docs/source/installation.rst | 2 +- setup.py | 4 ++-- 5 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 Makefile diff --git a/.github/workflows/pulser-setup/action.yml b/.github/workflows/pulser-setup/action.yml index 51b90b144..acfc7dfcb 100644 --- a/.github/workflows/pulser-setup/action.yml +++ b/.github/workflows/pulser-setup/action.yml @@ -21,7 +21,7 @@ runs: shell: bash run: | python -m pip install --upgrade pip - pip install -e ./pulser-core -e ./pulser-simulation + make dev-install - name: Install extra packages from the dev requirements if: "${{ inputs.extra-packages != '' }}" shell: bash diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..fa2aad32a --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +.PHONY: dev-install +dev-install: dev-install-core dev-install-simulation dev-install-pasqal + +.PHONY: dev-install-core +dev-install-core: + pip install -e ./pulser-core + +.PHONY: dev-install-simulation +dev-install-simulation: + pip install -e ./pulser-simulation + +.PHONY: dev-install-pasqal +dev-install-pasqal: + pip install -e ./pulser-pasqal \ No newline at end of file diff --git a/README.md b/README.md index ef6607edf..00b8e5af1 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ If you wish to **install the development version of Pulser from source** instead ```bash git checkout develop -pip install -e ./pulser-core -e ./pulser-simulation +make dev-install ``` Bear in mind that this installation will track the contents of your local diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 5ccc60f7c..36d348199 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -33,7 +33,7 @@ the ``develop`` branch - which holds the development (unstable) version of Pulse and install from source by running: :: git checkout develop - pip install -e ./pulser-core -e ./pulser-simulation + make dev-install Bear in mind that your installation will track the contents of your local Pulser repository folder, so if you checkout a different branch (e.g. ``master``), diff --git a/setup.py b/setup.py index fc1a95c21..d58354def 100644 --- a/setup.py +++ b/setup.py @@ -22,13 +22,13 @@ raise RuntimeError( "The 'pulser' distribution can only be installed or packaged for " "stable versions. To install the full development version, run " - "`pip install -e ./pulser-core -e ./pulser-simulation` instead." + "`make dev-install` instead." ) with open("packages.txt", "r") as f: requirements = [f"{pkg.strip()}=={__version__}" for pkg in f.readlines()] -# Just a meta-package that requires 'pulser-core' and 'pulser-simulation' +# Just a meta-package that requires all pulser packages setup( name="pulser", version=__version__, From 69ff9e785ceddde00bf85205a684d03d9b303e7b Mon Sep 17 00:00:00 2001 From: HGSilveri Date: Fri, 23 Sep 2022 12:29:33 +0200 Subject: [PATCH 3/3] Add a dummy UT --- tests/test_pasqal.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 tests/test_pasqal.py diff --git a/tests/test_pasqal.py b/tests/test_pasqal.py new file mode 100644 index 000000000..23e4f5e34 --- /dev/null +++ b/tests/test_pasqal.py @@ -0,0 +1,25 @@ +# Copyright 2022 Pulser Development Team +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +from __future__ import annotations + +from pathlib import Path + +import pulser +import pulser_pasqal + +root = Path(__file__).parent.parent + + +def test_version(): + assert pulser_pasqal.__version__ == pulser.__version__