jebej / Schrodinger.jl

Fast and easy simulation of quantum mechanical systems.
https://jebej.github.io/Schrodinger.jl/latest
Other
24 stars 6 forks source link

first pass docstring #11

Closed peterse closed 4 years ago

peterse commented 4 years ago

thoughts on format?

jebej commented 4 years ago

Thanks! Format was not right so I made an other commit here: https://github.com/jebej/Schrodinger.jl/commit/16418a0b0e37c9f4f0f0b039ec1904d5b6ae5445

Also, the Choi-Jamiolkowski isomorphism is not the Choi matrix, that's the operator-vector correspondence.

codecov[bot] commented 4 years ago

Codecov Report

Merging #11 into master will decrease coverage by 0.3%. The diff coverage is 70.7%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #11      +/-   ##
==========================================
- Coverage   44.45%   44.15%   -0.31%     
==========================================
  Files          36       36              
  Lines        1597     1583      -14     
==========================================
- Hits          710      699      -11     
+ Misses        887      884       -3
Impacted Files Coverage Δ
src/misc/utils.jl 40.67% <ø> (ø) :arrow_up:
src/math/special.jl 64.61% <ø> (ø) :arrow_up:
src/library/operators.jl 62.5% <ø> (ø) :arrow_up:
src/library/states.jl 96.55% <ø> (ø) :arrow_up:
src/library/drivefuns.jl 0% <0%> (ø) :arrow_up:
src/control/coherentsubspaces.jl 0% <0%> (ø) :arrow_up:
src/control/examples.jl 0% <0%> (ø) :arrow_up:
src/control/normpsu.jl 0% <0%> (ø) :arrow_up:
src/control/grape.jl 0% <0%> (ø) :arrow_up:
src/tomography/statetomo.jl 87.5% <80.95%> (-2.75%) :arrow_down:
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update dfcc668...4f125d2. Read the comment docs.

peterse commented 4 years ago

ok, sounds good.