File: README.md

package info (click to toggle)
qutip 4.5.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 3,764 kB
  • sloc: python: 38,325; cpp: 344; makefile: 36; sh: 12
file content (103 lines) | stat: -rw-r--r-- 4,777 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
QuTiP: Quantum Toolbox in Python
================================

[A. Pitchford](https://github.com/ajgpitch),
[C. Granade](https://github.com/cgranade),
[A. Grimsmo](https://github.com/arnelg),
[N. Shammah](https://github.com/nathanshammah),
[S. Ahmed](https://github.com/quantshah),
[N. Lambert](https://github.com/nwlambert),
[E. Giguère](https://github.com/ericgig),
[B. Li](https://github.com/boxili),
[J. Lishman](https://github.com/jakelishman),
[P. D. Nation](https://github.com/nonhermitian),
and [J. R. Johansson](https://github.com/jrjohansson)


QuTiP is open-source software for simulating the dynamics of closed and open
quantum systems. The QuTiP library uses the excellent Numpy, Scipy, and Cython packages as numerical backend, 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. QuTiP is freely available for use and/or
modification, and it can be used on all Unix-based platforms and on Windows.
Being free of any licensing fees, QuTiP is ideal for exploring quantum
mechanics in research as well as in the classroom.

Build status and test coverage
------------------------------

[![build-status](https://secure.travis-ci.org/qutip/qutip.svg?branch=master)](http://travis-ci.org/qutip/qutip)
[![Coverage Status](https://img.shields.io/coveralls/qutip/qutip.svg)](https://coveralls.io/r/qutip/qutip)
[![Maintainability](https://api.codeclimate.com/v1/badges/df502674f1dfa1f1b67a/maintainability)](https://codeclimate.com/github/qutip/qutip/maintainability)

Support
--------
[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)
[![Unitary Fund](https://img.shields.io/badge/Supported%20By-UNITARY%20FUND-brightgreen.svg?style=for-the-badge)](http://unitary.fund)

QuTiP development is supported by [Nori's lab](http://dml.riken.jp/)
at RIKEN, by the University of Sherbrooke, and by Aberystwyth University,
[among other supporting organizations](http://qutip.org/#supporting-organizations).

Download
--------
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/qutip/badges/downloads.svg)](https://anaconda.org/conda-forge/qutip)

The official releases of QuTiP can be downloaded at:

[http://qutip.org/download.html](http://qutip.org/download.html)


Installation
------------

For instructions on how to install QuTiP, see:

[http://qutip.org/docs/latest/installation.html](http://qutip.org/docs/latest/installation.html)


Run notebooks online
-----
A selection of demonstration notebooks is available at [http://qutip.org/tutorials.html](http://qutip.org/tutorials.html) and can be run online here: [![Binder](http://img.shields.io/badge/launch-binder-ff69b4.svg?style=flat)](http://mybinder.org/repo/qutip/qutip-notebooks/binder)

or may be found at: [github.com/qutip/qutip-notebooks](http://github.com/qutip/qutip-notebooks).


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

The documentation for official releases, in HTML and PDF formats, are available at:

[http://qutip.org/documentation.html](http://qutip.org/documentation.html)

and the development documentation is available at [github.com/qutip/qutip-doc](http://github.com/qutip/qutip-doc).

Contribute
----------

You are most welcome to contribute to QuTiP development by forking this
repository and sending pull requests, or filing bug reports at the
[issues page](http://github.com/qutip/qutip/issues), or send us bug reports,
questions, or your proposed changes to our
[QuTiP discussion group](http://groups.google.com/group/qutip).

All contributions are acknowledged in the
[contributors](http://github.com/qutip/qutip-doc/blob/master/contributors.rst)
section in the documentation.

Note that all contributions must adhere to the [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/).

For more information, including technical advice, please see [Contributing to QuTiP development](https://github.com/qutip/qutip-doc/blob/master/qutip_dev_contrib.md).

Changelog
---------

For release notes and a change log, see the
[changelog](http://github.com/qutip/qutip-doc/blob/master/changelog.rst)
section in the documentation.

License
-------
[![license](https://img.shields.io/badge/license-New%20BSD-blue.svg)](http://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_.28.22Revised_BSD_License.22.2C_.22New_BSD_License.22.2C_or_.22Modified_BSD_License.22.29)

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