Skip to content

Commit

Permalink
Merge pull request #2080 from Ericgig/doc.install_info
Browse files Browse the repository at this point in the history
Add pre release installation instruction
  • Loading branch information
Ericgig committed Feb 7, 2023
2 parents 1b8e7cc + 33db6b0 commit 6629056
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 2 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,17 @@ All back releases are also available for download in the [releases section of th
For the most complete set of release notes and changelogs for historic versions, see the [changelog](https://qutip.org/docs/latest/changelog.html) section in the documentation.


The pre-release of QuTiP 5.0 is available on PyPI and can be installed using pip:

```bash
pip install --pre qutip
```

This version breaks compatibility with QuTiP 4.7 in many small ways.
Please see the [changelog](https://github.com/qutip/qutip/blob/master/doc/changelog.rst) for a list of changes, new features and deprecations.
This version should be fully working. If you find any bugs, confusing documentation or missing features, please create a GitHub issue.


Documentation
-------------

Expand Down
22 changes: 20 additions & 2 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ In addition, there are several optional packages that provide additional functio
| ``pytest``, | 5.3+ | For running the test suite. |
| ``pytest-rerunfailures`` | | |
+--------------------------+--------------+-----------------------------------------------------+
| LaTeX | TeXLive 2009+| Needed if using LaTeX in matplotlib figures, or for |
| LaTeX | TeXLive 2009+| Needed if using LaTeX in matplotlib figures, or for |
| | | nice circuit drawings in IPython. |
+--------------------------+--------------+-----------------------------------------------------+

Expand Down Expand Up @@ -128,6 +128,24 @@ You activate the new environment by running
You can also install any more optional packages you want with ``conda install``, for example ``matplotlib``, ``ipython`` or ``jupyter``.


Installation of the pre-release of version 5
============================================

QuTiP version 5 has been in development for some time and brings many new features, heavily reworks the core functionalities of QuTiP.
It is available as a pre-release on PyPI. Anyone wanting to try the new features can install it with:

.. code-block:: bash
pip install --pre qutip
We expect the pre-release to fully work.
If you find any bugs, confusing documentation or missing features, please tell create an issue on `github <https://github.com/qutip/qutip/issues>`_.

This version breaks compatibility with QuTiP 4.7 in many small ways.
Please see the :doc:`changelog` for a list of changes, new features and deprecations.


.. _install-from-source:

Installing from Source
Expand Down Expand Up @@ -192,7 +210,7 @@ To install OpenMP support, if available, run:
This will attempt to load up OpenMP libraries during the compilation process, which depends on you having suitable C++ compiler and library support.
If you are on Linux this is probably already done, but the compiler macOS ships with does not have OpenMP support.
You will likely need to refer to external operating-system-specific guides for more detail here, as it may be very non-trivial to correctly configure.

If you wish to contribute to the QuTiP project, then you will want to create your own fork of `the QuTiP git repository <https://github.com/qutip/qutip>`_, clone this to a local folder, and install it into your Python environment using:

.. code-block:: bash
Expand Down

0 comments on commit 6629056

Please sign in to comment.