mcditoos/qutip-symbolic

Useful extensions of sympy.physics.quantum for symbolic computation in quantum physics.

qutip-symbolic

The qutip-symbolic package is a continuation of SymPsi, which is itself a fork of SymPy's sympy.physics.quantum package.

In contrast to SymPsi, qutip-symbolic aims to be an extension of sympy.physics.quantum, rather than a fork. The intention is to slowly contribute changes back to SymPy while maintaining a compatibility layer so that users of qutip-symbolic do not need to continually update their from qutip_symbolic import ... statements.

Installation

To install the package, download to source code and run

pip install qutip-symbolic

If you want to edit the source code, please download the source code and run the following command under the folder with setup.cfg.

pip install -e .

To build and test the documentation, additional packages need to be installed:

pip install matplotlib sphinx numpydoc sphinx_rtd_theme

Under the docs directory, use

make html

to build the documentation, or

make doctest

to test the code in the documentation.

Documentation

The latest documentation of qutip-symbolic hosted at qutip-symbolic.readthedocs.io/.

Testing

To test the installation from a download of the source code, run from the qutip-symbolic directory

pytest tests

Support

This package is supported and maintained by the same developers group as QuTiP.

QuTiP development is supported by Nori's lab at RIKEN, by the University of Sherbrooke, by Chalmers University of Technology, by Macquarie University and by Aberystwyth University, among other supporting organizations.

License

You are free to use this software, with or without modification, provided that the conditions listed in the LICENSE.txt file are satisfied.