From 109083eac9ae7b9f783e81ed682938d3e48e7ed0 Mon Sep 17 00:00:00 2001 From: Simon Humpohl Date: Mon, 1 Oct 2018 11:30:08 +0200 Subject: [PATCH 1/2] Bump version to 0.2 and update release notes. --- ReleaseNotes.txt | 2 ++ qupulse/__init__.py | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt index 13bfe4948..9e450cec6 100644 --- a/ReleaseNotes.txt +++ b/ReleaseNotes.txt @@ -1,5 +1,7 @@ ## pending/current ## +## 0.2 ## + - General: - officially removed support for Python 3.3 (qupulse and dependencies are not compatible anymore) diff --git a/qupulse/__init__.py b/qupulse/__init__.py index 769197250..8fd362739 100644 --- a/qupulse/__init__.py +++ b/qupulse/__init__.py @@ -1,5 +1,5 @@ from qupulse.utils.types import MeasurementWindow, ChannelID from . import pulses -__version__ = '0.1.2' +__version__ = '0.2' __all__ = ["MeasurementWindow", "ChannelID", "pulses"] From d22f81327b186a430b2497e5fb58cde67c1ac04e Mon Sep 17 00:00:00 2001 From: Lukas Prediger Date: Tue, 2 Oct 2018 08:57:59 +0200 Subject: [PATCH 2/2] Updated readme. - Referred to PyPi in addition to out-of-repo install. - Mentioned which versions/dependencies are tested. - Added dependency version installation hints (requirements.txt) --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e29bd8066..dee2b2928 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,23 @@ The current feature list is as follows: - MATLAB interface to access qupulse functionality ## Installation -qupulse is developed using Python 3.5 but should also run on previous 3.3+ versions. +qupulse is available on [PyPi](https://pypi.org/project/qupulse/) and the latest release can be installed by executing: +``` +pip3 install qupulse +``` +qupulse version numbers follow the [Semantic Versioning](https://semver.org/) conventions. -The package is installed by executing in the cloned repository root folder: +Alternatively, the current development version of qupulse can be installed by executing in the cloned repository root folder: ``` pip3 install . ``` +qupulse is developed using Python 3.6 and tested on 3.4 - 3.6. It relies on some external Python packages as dependencies; +`requirements.txt` lists the versions of these qupulse is developed against and tested with. +We intentionally did not restrict versions of dependencies in the install scripts to not unnecessarily prevent usage of +newer releases of dependencies that might be compatible. However, if qupulse does encounter problems with a particular dependency version, +try installing the version listed in `requirements.txt`. + The backend for TaborAWGs requires packages that can be found [here](https://git.rwth-aachen.de/qutech/python-TaborDriver). The data acquisition backend for AlazarTech cards needs a package that unfortunately is not open source (yet). If you need it or have questions contact .