From 4606bf545f0835c8b85fc829e3d01439d1964c05 Mon Sep 17 00:00:00 2001 From: Simon Cross Date: Thu, 19 Jan 2023 15:51:46 +0100 Subject: [PATCH] Add note to README on master branch switching to v5. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 67eef9bf2b..eb08599852 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,19 @@ and [J. R. Johansson](https://github.com/jrjohansson) [![PyPi Downloads](https://img.shields.io/pypi/dm/qutip?label=downloads%20%7C%20pip&logo=PyPI)](https://pypi.org/project/qutip) [![Conda-Forge Downloads](https://img.shields.io/conda/dn/conda-forge/qutip?label=downloads%20%7C%20conda&logo=Conda-Forge)](https://anaconda.org/conda-forge/qutip) +> **Note** +> +> The master branch now contains the alpha version of QuTiP 5. This is major +> revision that breaks compatibility in many small ways withh QuTiP 4.7. +> +> If you need to track QuTiP 4.7 changes or submit pull requests for 4.7, +> please use the `qutip-4.7.X` branch. +> +> If you need to track QuTiP 5 changes or submit pull request for 5, +> please use the `master` branch (and not the `dev.major` branch). +> +> The change to master happened on 16 January 2023 in commit @fccec5d. + QuTiP is open-source software for simulating the dynamics of closed and open quantum systems. It uses the excellent Numpy, Scipy, and Cython packages as numerical backends, and graphical output is provided by Matplotlib. QuTiP aims to provide user-friendly and efficient numerical simulations of a wide variety of quantum mechanical problems, including those with Hamiltonians and/or collapse operators with arbitrary time-dependence, commonly found in a wide range of physics applications.