Looking great ! Will look into the notebook a bit more in depth tomorrow!

Giulio Ungaretti

On 4 July 2016 at 00:00:05, Adriaan ([email protected](mailto:[email protected])) wrote:

@giulioungaretti(https://github.com/giulioungaretti) @alexcjohnson(https://github.com/alexcjohnson)
Fixes part of #231(https://github.com/qdev-dk/Qcodes/issues/231).

Changes proposed in this pull request:

Made a new examples notebook named "Tutorial"
Promote "good" practices in the example notebook
Removed setting the default measurement from the station (I recall we discussed removing this feature altogether on slack).
Set the location formatter in the beginning of the session (thanks @damazter(https://github.com/damazter) )
Reuse the plotting window

Structure of notebook should give a better idea how the example relates to real life usage
Combines information of older example notebooks (suggest deleting those before merge)
load_and_plot_old_data.ipynb
examples.ipynb
metadata and metadata with instrument (@MerlinSmiles(https://github.com/merlinsmiles), maybe I missed something that happens there?)
location provider (recommend not deleting this one as it is more detailed)

While making this notebook I came across 1 other bug.

live plot updating does not work on my mac, calling update solves it and runs very fast so minor for the moment.
When clearing the pyqtgraph plotting windows the title remains the same as the initial one, cosmetic at this point but maybe relevant at a later stage.

The presentation I also added is still missing some useful diagrams and concepts at this point.I'm giving it tomorrow morning but I would appreciate any feedback, I think we can also use it as a starting point for further tutorials but I'll leave that to anyone who is interested in going in that direction.

Good night :)

You can view, comment on, or merge this pull request online at:

https://github.com/qdev-dk/Qcodes/pull/250

Commit Summary
Tutorial, presentation + notebook
Added text delft

File Changes
A docs/160703 QCodes Tutorial.pptx(https://github.com/qdev-dk/Qcodes/pull/250/files#diff-0) (0)
A docs/examples/Tutorial.ipynb(https://github.com/qdev-dk/Qcodes/pull/250/files#diff-1) (941)

Patch Links:
https://github.com/qdev-dk/Qcodes/pull/250.patch
https://github.com/qdev-dk/Qcodes/pull/250.diff

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub(https://github.com/qdev-dk/Qcodes/pull/250), or mute the thread(https://github.com/notifications/unsubscribe/ACkcN59BdGPMAWHdRq-SbJ-v3uT5YxRyks5qSDDlgaJpZM4JD9Rh).

Noticed another thing, because the mock instruments are located in the examples directory it is impossible to run the code from the notebook outside of the qcodes directory.

This is particularly problematic because the notebooks target the novice user who will not be able to figure out easily why the same code doesn't run in their test session. I suggest we move the mock instruments to a mock_instruments directory in the main qcodes path such that it will work for pip installed qcodes.

@giulioungaretti ?

Ok looks good to me, I would just remove the hack-y update thing and make an bug report :/
It's not cosmetic actually, it's really important that things work they way one expects.

Agree with deleting:
but maybe not Metadata and metadata with instrument (@MerlinSmiles, feedback)
and location provider

Just in case: ok looks good to me means that is a very nice tutorial!

@giulioungaretti @AdriaanRol
I think before deleting very specific notebooks we should have those cookbook style docs where we can have those specifics layed out once, without all the standard stuff around it.

Ok looks good to me, I would just remove the hack-y update thing and make an bug report :/
It's not cosmetic actually, it's really important that things work they way one expects.

@giulioungaretti I made a bug report #259 , I have removed the hack everywhere but left it in as a commented out suggestion with a reference to #259. I suggest we leave it there until #259 is resolved. Mostly for the sake of new users who are not aware of this issue.

@MerlinSmiles I agree on the desire to have the cookbook style documentation. I think this is another issue.

I think ideally all of these notebooks should be merged into the tutorial. I have so far deleted two of them, "example" and "load_and_plot" which are both fully contained within the tutorial. I would argue that the rest can be deleted aswell but these are not fully copied so I have not removed them.

@giulioungaretti , the Travis check build fails, I assume this is because the master I pulled from also failed (as I saw lots of failing checks last week and I noticed you fixed some things).

If both of you are OK I will merge.