Giter Club home page Giter Club logo

qutip.github.io's Introduction

QuTiP: Quantum Toolbox in Python

A. Pitchford, C. Granade, A. Grimsmo, N. Shammah, S. Ahmed, N. Lambert, E. Giguère, B. Li, J. Lishman, S. Cross, A. Galicia, P. Menczel, P. Hopf, P. D. Nation, and J. R. Johansson

Build Status Coverage Status Maintainability license PyPi Downloads Conda-Forge Downloads

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. 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.

Support

Unitary Fund Powered by NumFOCUS

We are proud to be affiliated with Unitary Fund and numFOCUS.

We are grateful for Nori's lab at RIKEN and Blais' lab at the Institut Quantique for providing developer positions to work on QuTiP.

We also thank Google for supporting us by financing GSoC students to work on the QuTiP as well as other supporting organizations that have been supporting QuTiP over the years.

Installation

Pip Package Conda-Forge Package

QuTiP is available on both pip and conda (the latter in the conda-forge channel). You can install QuTiP from pip by doing

pip install qutip

to get the minimal installation. You can instead use the target qutip[full] to install QuTiP with all its optional dependencies. For more details, including instructions on how to build from source, see the detailed installation guide in the documentation.

All back releases are also available for download in the releases section of this repository, where you can also find per-version changelogs. For the most complete set of release notes and changelogs for historic versions, see the changelog section in the documentation.

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

pip install --pre qutip

This version breaks compatibility with QuTiP 4.7 in many small ways. Please see the changelog 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

Documentation Status - Latest

The documentation for the latest stable release and the master branch is available for reading on Read The Docs.

The documentation for official releases, in HTML and PDF formats, can be found in the documentation section of the QuTiP website.

The latest development documentation is available in this repository in the doc folder.

A selection of demonstration notebooks is available, which demonstrate some of the many features of QuTiP. These are stored in the qutip/qutip-tutorials repository here on GitHub.

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. You can also help out with users' questions, or discuss proposed changes in the QuTiP discussion group. All code contributions are acknowledged in the contributors section in the documentation.

For more information, including technical advice, please see the "contributing to QuTiP development" section of the documentation.

Citing QuTiP

If you use QuTiP in your research, please cite the original QuTiP papers that are available here.

qutip.github.io's People

Contributors

agaliciamartinez avatar ajgpitch avatar araza6 avatar bencbartlett avatar boxili avatar christian512 avatar ericgig avatar hodgestar avatar jakelishman avatar jrjohansson avatar kafischer avatar kwyip avatar nathanshammah avatar nonhermitian avatar nwlambert avatar purva-thakre avatar quantshah avatar rganardi avatar splch avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

qutip.github.io's Issues

Add information on governance

Add information on qutip governance:

  • devs --> admins (where it applies);
  • add board members
  • add news in news section
  • update qutip/governance

transform keeps tensor structure

I understand that basis transforms are in development. But I saw one thing that might be worth considering:

The dims propery of property is unaffected by doing a transform even though nothing guerantees that the product structure remains. Partial traces become meaningless (unless the origin of that structure is kept).

Either one has to keep a copy of the transform in the transformed object to still be able to trace out factors or the resulting object has to become unfactorizable...

... I think...

Cheers,
Christoph

ENH: Interactive notebooks from the website tutorials page

On the tutorials page, the notebooks can be seen using nbviewer. The notebooks are hosted in qutip-notebooks Github directory and in R.J. Johansson directory.

There is now a button to start My Binder from these nbviewer notebooks, in the upper right (My Binder allows to run the notebooks live interactively from the cloud, without installing Python or the environment with dependencies).

It may be nice to add a links to:

  • My Binder
  • nbviewer (full directory)

in the tutorials page on the website. Right now, My Binder can be called from Github only. Also, a nbviewer link is opened for each notebook only.

The quantum mechanics lectures by Rob do not run, as the conda environment is not configured. One could:

  • push an environment.yml file to that directory
    or
  • clone the tutorials in the qutip-notebooks directory and add a link in the notebooks to Rob's folder. This way, each software update in the environment.yml file will affect also these files.

Fix broken links and add missing slides

Some of the links in the News section have changed over time, e.g., some conferences removed hosted slides. We can add links to another repository with talks or a subfloder in this repository, see also #1087.

ENH: Add qip.noise section in tutorials page

We need to add a section in the tutorials page under the quantum circuits section. This could be a section per se, in order to make it stand out clearly. It should be referenced at the beginning of the page with a label too. @BoxiLi can you take care of it? Or else I can.

Fixing the "hidden underscore" problem

Hi guys,

I was just messing around with my own Sphinx stuff, and I've stumbled upon the way to get GitHub pages to recognise files and folders that begin with an underscore (like _static and so forth). It's simple, but incredibly esoteric - you just drop a file called .nojekyll in the HTML root, and magically they'll all work again.

I don't know how your deploy process goes for building this repo from the qutip/qutip-docs one so I didn't make a PR, but hopefully this helps simplify things a bit.

@nathanshammah.

How to link model notebooks

@nathanshammah @sahmed95
We now need to decide how to link the piqs notebooks on the website.

I suggest a section 'Models' under 'Example notebooks' with a subsection 'Permutational Invariant Quantum Solver' with the notebooks linked under that.

Open to alternatives.

Possible syntax error

When running the example on [http://qutip.org/docs/3.1.0/guide/guide-bloch.html#bloch-config]

I encounter the SyntaxError: invalid syntax on the line
ffmpeg -r 20 -b 1800 -i bloch_%01d.png bloch.mp4.

While on Directly Generating an Animation section,
I encounter NameError: name 'Bloch' is not defined on the line
sphere = Bloch(axes=ax).

Maybe this is just due to my old version of qutip? Thanks.

Links to Jupyter notebooks dead

A few of the links to Jupyter notebooks in the online documentation are dead. However, they are referred to correctly in the tutorials section

source files for the header images

@nonhermitian could you add the source files for the header image to the repository? I am working on a small redesign of the pages that involves a sidebar, and I would like to widen the whole pages a bit. But the header a fixed number of pixels. Thanks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.