Giter VIP home page Giter VIP logo

quantumoptics.jl-documentation's Introduction

QuantumOptics.jl documentation

This is the source repository for the documentation. You can find an already built version of the documentation at https://docs.qojulia.org/. The documentation is built using markdown files and Documenter.jl and includes resources from QuantumOptics.jl and QuantumOptics.jl-examples:

  • Functions exported from QuantumOptics.jl are included in api.md.
  • Examples from QuantumOptics.jl-examples are included in src/examples

Directory layout

When building the documentation the only requirement is that the notebooks from the examples repo have been executed and copied over by make.jl from the examples directory. | |--> ./QuantumOptics.jl-documentation/ |

Software requirements

  • Documenter.jl (Can be installed with julia> Pkg.add("Documenter"))

Build process

  • Make sure the correct version of QuantumOptics.jl is in the Julia searchpath.
  • Build QuantumOptics.jl-examples. Output will automatically be copied into src/examples.
  • Run julia make.jl. This will generate the documentation in the build directory.

quantumoptics.jl-documentation's People

Contributors

amilsted avatar bastikr avatar christophhotter avatar david-pl avatar goropikari avatar

Stargazers

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

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

quantumoptics.jl-documentation's Issues

Missing details about default solver options

I'm wondering about the choice of default solver options;
DP5() for the algorithm,
https://github.com/qojulia/QuantumOptics.jl/blob/8012aa8cb224df75dcc0e1301b24c740c616d330/src/timeevolution_base.jl#L14-L18
and for the tolerance,
https://github.com/qojulia/QuantumOptics.jl/blob/8012aa8cb224df75dcc0e1301b24c740c616d330/src/timeevolution_base.jl#L59-L66

I can relate to the tolerance choice, as the default in DiffEqBase is quite low in my opinion (reltol=1e-3 & abstol=1e-6).
But not sure about the algorithm, why DP5 ? and not Tsit5 (as recommended for non-stiff problems)? or letting DiffEq choose automatically (with alg=nothing)?

The Time-evolution doesn't offer much insight.
I would love for the reasoning for this to be documented ๐Ÿ™

Tiny error in documentation

image
As the image shows, you defines different potential for H.
When I try to calculate period of time evolution using ฯ‰, I notice that.

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.