Skip to content
Snippets Groups Projects
Commit 0e1c7174 authored by Gary Steele's avatar Gary Steele
Browse files

translating our ballooning word doc in teams into some markdown files to deploy

parent d3ce2d55
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Information about TN2513-P Squid Practicum.ipynb 0 → 100644
+ 290
− 0
View file @ 0e1c7174
%% Cell type:markdown id: tags:
# Information about TN2513-P Squid Practicum
%% Cell type:markdown id: tags:
<h1>Table of Contents<span class="tocSkip"></span></h1>
<div class="toc"><ul class="toc-item"><li><span><a href="#General-overview-of-the-SQUID-RP" data-toc-modified-id="General-overview-of-the-SQUID-RP-1">General overview of the SQUID RP</a></span></li><li><span><a href="#MS-Teams" data-toc-modified-id="MS-Teams-2">MS Teams</a></span></li><li><span><a href="#The-experiments" data-toc-modified-id="The-experiments-3">The experiments</a></span></li><li><span><a href="#Background-reading-and-preparation--before-you-start" data-toc-modified-id="Background-reading-and-preparation--before-you-start-4">Background reading and preparation before you start</a></span><ul class="toc-item"><li><ul class="toc-item"><li><span><a href="#Feynman-lectures-on-superconductivity" data-toc-modified-id="Feynman-lectures-on-superconductivity-4.0.1">Feynman lectures on superconductivity</a></span></li><li><span><a href="#Instructional-videos" data-toc-modified-id="Instructional-videos-4.0.2">Instructional videos</a></span></li><li><span><a href="#SQUID-Practicum-Manual" data-toc-modified-id="SQUID-Practicum-Manual-4.0.3">SQUID Practicum Manual</a></span></li><li><span><a href="#Mr.-SQUID-Hardware-User-manual" data-toc-modified-id="Mr.-SQUID-Hardware-User-manual-4.0.4">Mr. SQUID Hardware User manual</a></span></li></ul></li></ul></li><li><span><a href="#Safety" data-toc-modified-id="Safety-5">Safety</a></span></li><li><span><a href="#The-first-session" data-toc-modified-id="The-first-session-6">The first session</a></span></li><li><span><a href="#Documenting-what-you-do" data-toc-modified-id="Documenting-what-you-do-7">Documenting what you do</a></span></li><li><span><a href="#Deadlines-and-planning" data-toc-modified-id="Deadlines-and-planning-8">Deadlines and planning</a></span></li><li><span><a href="#Submitting-your-report" data-toc-modified-id="Submitting-your-report-9">Submitting your report</a></span></li><li><span><a href="#Our-expectations-of-you" data-toc-modified-id="Our-expectations-of-you-10">Our expectations of you</a></span></li><li><span><a href="#Communication" data-toc-modified-id="Communication-11">Communication</a></span></li><li><span><a href="#Report-appendices-for-the-SQUID-RP" data-toc-modified-id="Report-appendices-for-the-SQUID-RP-12">Report appendices for the SQUID RP</a></span></li><li><span><a href="#Report-Writing-Guidelines-and-Advice" data-toc-modified-id="Report-Writing-Guidelines-and-Advice-13">Report Writing Guidelines and Advice</a></span></li></ul></div>
%% Cell type:markdown id: tags:
## General overview of the SQUID RP
For this RP, we typically plan 3 half days (“sessions”) for you to work in the lab. During the sessions, we will provide you with liquid nitrogen at the start of the session and we will provide “immediate response” video support to help you with any problems you run into. We will guarantee to provide video support for a half day (say 4 hours), but you are also welcome to continue your measurements in the lab after 4 hours as long as it is during normal working hours.
The during the first two, you will collect as much data as you can, and prepare an intermediate report of the data you took and the analysis you have done so far. The report should not be a “written” report but be in the format of slides showing the plots of representative data you have taken along with comments and questions you might have about the data. This report will be shared with the supervisors by posting a PDF in the channel.
Before the 3rd session, we will schedule a 30-minute “interim report” video meeting with the Gary and the supervising PhD student to discuss the intermediate results and make a plan for the third sessions.
We also arrange a 30-minute “kickoff meeting” on Zoom after you have read the background reading material to answer any questions about the background reading material and go over the planning for the first day.
**Week 1: Reading and planning**
* Monday: you should have contacted us by email
* Start reading background material
* Watch (at least) the following videos: Safety, Hardware Intro, Software Intro
**Week 2: Experiments Week 1**
* Post questions about reading material or videos in channel
* Kickoff meeting
* First session at least should take place in this week
**Week 3: Experiments Week 2**
* Second session
* Post interim analysis
* Interim discussion meeting
* Third session (if needed or desired)
%% Cell type:markdown id: tags:
## MS Teams
We will use MS Teams for communicated and also for sharing documents with you. You will need to request access to our team by using this link:
<a href="https://teams.microsoft.com/l/team/19%3ac8434d872555441e92713bbf77a7be03%40thread.tacv2/conversations?groupId=05ad1819-d348-4eda-9ea1-65eb9a7a8cef&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b">TN2953-P QN Squid Practicum MS Teams Team</a>
%% Cell type:markdown id: tags:
## The experiments
There are three “baseline” experiments you should aim at completing during the first two sessions:
* Measuring and analysing the superconducting IV
* Measuring and analysing the superconducting transition temperature
* Measuring and analysing quantum interference using flux oscillations
Based on our discussion during the interim meeting, we will look at the planning for the third session. The focus of the discussion will be to determine if you have sufficient experimental data and sufficient analysis to draw conclusions about these three topics for your report, and if not, to make a detailed plan for the third day in order to make sure we have what we need. If the data an analysis is clear enough, one option could be to explore one of the many possible additional experiments with the setup, based on one of the extended experiment options from the Mr. SQUID manual, based your own ideas, or based on something you noticed during the measurements you want to explore in more detail.
%% Cell type:markdown id: tags:
## Background reading and preparation before you start
To prepare for the practicum, there is some important background reading, outlined here:
#### Feynman lectures on superconductivity
* You can find them <a href=https://tud365.sharepoint.com/sites/TN2953-PQNSquidPracticum/Gedeelde%20documenten/General/feynman_lectures_superconductivity.pdf>in Teams here</a>
* This should give you an introduction to superconducitivity in general, to the Josephson junction and quantum tunneling, and to the SQUID and quantum interference
#### Instructional videos
* A document describing them and linking to them can be found <a href=https://tud365.sharepoint.com/sites/TN2953-PQNSquidPracticum/Gedeelde%20documenten/General/Instructional%20Videos.pdf>here</a>
* These contain information about all the things you will do and what we expect from you during the practicum
* Before the kickoff meeting, you should watch the following videos:
* Safety
* Hardware introduction
* Software introduction
#### SQUID Practicum Manual
* Find it here (add link!)
* This has some additional background reading about superconductivity and Josephson Junctions
* It also has a description of the experiments you will perform, along with some suggestions for thinks you should be thinking about when you are doing the experiments and analysing the data
#### Mr. SQUID Hardware User manual
* Find it <a href=https://tud365.sharepoint.com/sites/TN2953-PQNSquidPracticum/Gedeelde%20documenten/General/mr_squid_user_guide.pdf>here</a>
* This is the “full user manual” from the manufacturer
* It contains more information about how the hardware works, in more depth than is included in the hardware introduction video
%% Cell type:markdown id: tags:
## Safety
In this RP, you will work with liquid nitrogen, which carriers the risk of serious frost burns and of suffocation if the proper safety guidelines are not followed. Please watch the safety video carefully, and follow the following guidelines:
* Always use the gloves and safety glasses when inserting or removing the probe from the liquid nitrogen
* Leave the door open and open the window a crack to reduce the risk of suffocation
* Leave the room immediately if you spill the nitrogen on the floor and wait until the room has ventilated before re-entereing
%% Cell type:markdown id: tags:
## The first session
To prepare for your first session, you should:
* Watch all the instructional videos, which show you the basics of how to do the experiments, use the hardware, use the software, and document your results
* Take a look at the MrSQUID instruction manual PDF. It is a good reference for the setup, although our software makes using it a bit easier for you
As preparation for the kickoff meeting, please post the following in your Teams channel:
* Prepare a list of (at least) 3 questions you have about the theory you have read and the videos you have watched
At the end of the first session, make sure to:
* Take a picture of the paper logbook and post it in the channel
* Turn of the power of the MrSQUID box
%% Cell type:markdown id: tags:
## Documenting what you do
It is very important to us that you learn to document carefully what you do in the experiments. For this, we have designed measurement software to make it easy to take lots of data with systematic file names, provided code for automatically plotting your data while you are working, and some example notebooks on how to document your results in Jupyter notebooks. Please see the instructional videos for more information.
%% Cell type:markdown id: tags:
## Deadlines and planning
Please fill in the below with you’re the desired dates for your sessions, and then the resulting deadlines for your round. For scheduling the Zoom meetings, please first consult the time availability on the combined agenda availability of the supervisors (ask in channel). Based on this, suggest time slots in the channel, and Gary will send a calendar invitation with a Zoom link.
At the kickoff meeting, we will copy the following into a document in your channel and fill it in together:
Planning of sessions and meetings (fill in date, eg. “Monday Dec 10”)
* Kickoff meeting on Zoom: “...” at XX.XX
* First session: “...” starting at XX.XX
* Second session: “...” starting at XX.XX
* Intermediate report meeting: “...” at XX.XX
* Third session: “...” starting at XX.XX
Deadlines:
* Questions about reading material posted in channel:
* Date: “...”
* Intermediate report slides posted in channel:
* Date: “...”
* First version of report:
* Date: “...”
* Final version of report:
* Date: “...”
%% Cell type:markdown id: tags:
## Submitting your report
Please submit the reports via Brightspace, other information can be posted in the channel
%% Cell type:markdown id: tags:
## Our expectations of you
The RP is setup with some “core” experiments in which you can observe some of the basic phenomena and get experienced with performing the measurements.
In the documentation, you can find a description of lots of different things you can explore with the setup, and we have tried to express different avenues you can explore if you want and if you have time once you have clearly established and are confident about your analysis the “core” results.
Note, though, that these extra experiments are not necessary for a high grade: doing “extra experiments” but at the same time not mastering an in-depth understanding of the core experiments will result in, if anything, a significantly lower grade. It is more important to us that you really think about what you are doing while you are working, that you are observant, and that you do a robust analysis of the results you obtain.
%% Cell type:markdown id: tags:
## Communication
Communication is very important to us: we would rather have more communication that less! The last thing we want is for you to be stuck trying to figure something out for a long time. If you have a question, please, just ask!
How to ask? One place is during the “live support” hours during the lab sessions. Another place is during the discussion of the intermediate report. Then it is easy since you will have us as a captive audience.
BUT PLEASE DO NOT RESTRICT YOUR QUESTIONS TO THESE TWO TIMESLOTS! In particular, please make use of the Teams “channel” for communicating with us whenever you have a question. If you get stuck, don’t wait, JUST POST! We will do our best to answer your question as quickly as we can. And maybe sometimes you answer it yourself before we get back to you: also fine, no problem, just post again saying you figured it out! If you are able to take advantage of the channel to communicate with us fluidly, it will be very beneficial for your experience in this RP.
%% Cell type:markdown id: tags:
## Report appendices for the SQUID RP
For this practicum, we will ask specifically for some additional appendices as a minimum:
* Appendix 1: Photographs of your paper logbooks
* Appendix 2: Copy of the “plot all my data” jupyter notebook
* Appendix 3: Code used to generate the plots in your report
* When writing your report, you will write code to make the plots in your report. We will ask that you include this code as Appendix 3.
%% Cell type:markdown id: tags:
## Report Writing Guidelines and Advice
We have an additional page where we describe our advice for writing your report.
Information about TN2513-P Squid Practicum.md 0 → 100644
+ 201
− 0
View file @ 0e1c7174
---
jupyter:
jupytext:
formats: ipynb,md
text_representation:
extension: .md
format_name: markdown
format_version: '1.3'
jupytext_version: 1.10.1
kernelspec:
display_name: Python 3
language: python
name: python3
---
# Information about TN2513-P Squid Practicum
<!-- #region toc=true -->
<h1>Table of Contents<span class="tocSkip"></span></h1>
<div class="toc"><ul class="toc-item"><li><span><a href="#General-overview-of-the-SQUID-RP" data-toc-modified-id="General-overview-of-the-SQUID-RP-1">General overview of the SQUID RP</a></span></li><li><span><a href="#MS-Teams" data-toc-modified-id="MS-Teams-2">MS Teams</a></span></li><li><span><a href="#The-experiments" data-toc-modified-id="The-experiments-3">The experiments</a></span></li><li><span><a href="#Background-reading-and-preparation--before-you-start" data-toc-modified-id="Background-reading-and-preparation--before-you-start-4">Background reading and preparation before you start</a></span><ul class="toc-item"><li><ul class="toc-item"><li><span><a href="#Feynman-lectures-on-superconductivity" data-toc-modified-id="Feynman-lectures-on-superconductivity-4.0.1">Feynman lectures on superconductivity</a></span></li><li><span><a href="#Instructional-videos" data-toc-modified-id="Instructional-videos-4.0.2">Instructional videos</a></span></li><li><span><a href="#SQUID-Practicum-Manual" data-toc-modified-id="SQUID-Practicum-Manual-4.0.3">SQUID Practicum Manual</a></span></li><li><span><a href="#Mr.-SQUID-Hardware-User-manual" data-toc-modified-id="Mr.-SQUID-Hardware-User-manual-4.0.4">Mr. SQUID Hardware User manual</a></span></li></ul></li></ul></li><li><span><a href="#Safety" data-toc-modified-id="Safety-5">Safety</a></span></li><li><span><a href="#The-first-session" data-toc-modified-id="The-first-session-6">The first session</a></span></li><li><span><a href="#Documenting-what-you-do" data-toc-modified-id="Documenting-what-you-do-7">Documenting what you do</a></span></li><li><span><a href="#Deadlines-and-planning" data-toc-modified-id="Deadlines-and-planning-8">Deadlines and planning</a></span></li><li><span><a href="#Submitting-your-report" data-toc-modified-id="Submitting-your-report-9">Submitting your report</a></span></li><li><span><a href="#Our-expectations-of-you" data-toc-modified-id="Our-expectations-of-you-10">Our expectations of you</a></span></li><li><span><a href="#Communication" data-toc-modified-id="Communication-11">Communication</a></span></li><li><span><a href="#Report-appendices-for-the-SQUID-RP" data-toc-modified-id="Report-appendices-for-the-SQUID-RP-12">Report appendices for the SQUID RP</a></span></li><li><span><a href="#Report-Writing-Guidelines-and-Advice" data-toc-modified-id="Report-Writing-Guidelines-and-Advice-13">Report Writing Guidelines and Advice</a></span></li></ul></div>
<!-- #endregion -->
## General overview of the SQUID RP
For this RP, we typically plan 3 half days (“sessions”) for you to work in the lab. During the sessions, we will provide you with liquid nitrogen at the start of the session and we will provide “immediate response” video support to help you with any problems you run into. We will guarantee to provide video support for a half day (say 4 hours), but you are also welcome to continue your measurements in the lab after 4 hours as long as it is during normal working hours.
The during the first two, you will collect as much data as you can, and prepare an intermediate report of the data you took and the analysis you have done so far. The report should not be a “written” report but be in the format of slides showing the plots of representative data you have taken along with comments and questions you might have about the data. This report will be shared with the supervisors by posting a PDF in the channel.
Before the 3rd session, we will schedule a 30-minute “interim report” video meeting with the Gary and the supervising PhD student to discuss the intermediate results and make a plan for the third sessions.
We also arrange a 30-minute “kickoff meeting” on Zoom after you have read the background reading material to answer any questions about the background reading material and go over the planning for the first day.
**Week 1: Reading and planning**
* Monday: you should have contacted us by email
* Start reading background material
* Watch (at least) the following videos: Safety, Hardware Intro, Software Intro
**Week 2: Experiments Week 1**
* Post questions about reading material or videos in channel
* Kickoff meeting
* First session at least should take place in this week
**Week 3: Experiments Week 2**
* Second session
* Post interim analysis
* Interim discussion meeting
* Third session (if needed or desired)
## MS Teams
We will use MS Teams for communicated and also for sharing documents with you. You will need to request access to our team by using this link:
<a href="https://teams.microsoft.com/l/team/19%3ac8434d872555441e92713bbf77a7be03%40thread.tacv2/conversations?groupId=05ad1819-d348-4eda-9ea1-65eb9a7a8cef&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b">TN2953-P QN Squid Practicum MS Teams Team</a>
## The experiments
There are three “baseline” experiments you should aim at completing during the first two sessions:
* Measuring and analysing the superconducting IV
* Measuring and analysing the superconducting transition temperature
* Measuring and analysing quantum interference using flux oscillations
Based on our discussion during the interim meeting, we will look at the planning for the third session. The focus of the discussion will be to determine if you have sufficient experimental data and sufficient analysis to draw conclusions about these three topics for your report, and if not, to make a detailed plan for the third day in order to make sure we have what we need. If the data an analysis is clear enough, one option could be to explore one of the many possible additional experiments with the setup, based on one of the extended experiment options from the Mr. SQUID manual, based your own ideas, or based on something you noticed during the measurements you want to explore in more detail.
## Background reading and preparation before you start
To prepare for the practicum, there is some important background reading, outlined here:
#### Feynman lectures on superconductivity
* You can find them <a href=https://tud365.sharepoint.com/sites/TN2953-PQNSquidPracticum/Gedeelde%20documenten/General/feynman_lectures_superconductivity.pdf>in Teams here</a>
* This should give you an introduction to superconducitivity in general, to the Josephson junction and quantum tunneling, and to the SQUID and quantum interference
#### Instructional videos
* A document describing them and linking to them can be found <a href=https://tud365.sharepoint.com/sites/TN2953-PQNSquidPracticum/Gedeelde%20documenten/General/Instructional%20Videos.pdf>here</a>
* These contain information about all the things you will do and what we expect from you during the practicum
* Before the kickoff meeting, you should watch the following videos:
* Safety
* Hardware introduction
* Software introduction
#### SQUID Practicum Manual
* Find it here (add link!)
* This has some additional background reading about superconductivity and Josephson Junctions
* It also has a description of the experiments you will perform, along with some suggestions for thinks you should be thinking about when you are doing the experiments and analysing the data
#### Mr. SQUID Hardware User manual
* Find it <a href=https://tud365.sharepoint.com/sites/TN2953-PQNSquidPracticum/Gedeelde%20documenten/General/mr_squid_user_guide.pdf>here</a>
* This is the “full user manual” from the manufacturer
* It contains more information about how the hardware works, in more depth than is included in the hardware introduction video
## Safety
In this RP, you will work with liquid nitrogen, which carriers the risk of serious frost burns and of suffocation if the proper safety guidelines are not followed. Please watch the safety video carefully, and follow the following guidelines:
* Always use the gloves and safety glasses when inserting or removing the probe from the liquid nitrogen
* Leave the door open and open the window a crack to reduce the risk of suffocation
* Leave the room immediately if you spill the nitrogen on the floor and wait until the room has ventilated before re-entereing
<!-- #region -->
## The first session
To prepare for your first session, you should:
* Watch all the instructional videos, which show you the basics of how to do the experiments, use the hardware, use the software, and document your results
* Take a look at the MrSQUID instruction manual PDF. It is a good reference for the setup, although our software makes using it a bit easier for you
As preparation for the kickoff meeting, please post the following in your Teams channel:
* Prepare a list of (at least) 3 questions you have about the theory you have read and the videos you have watched
At the end of the first session, make sure to:
* Take a picture of the paper logbook and post it in the channel
* Turn of the power of the MrSQUID box
<!-- #endregion -->
## Documenting what you do
It is very important to us that you learn to document carefully what you do in the experiments. For this, we have designed measurement software to make it easy to take lots of data with systematic file names, provided code for automatically plotting your data while you are working, and some example notebooks on how to document your results in Jupyter notebooks. Please see the instructional videos for more information.
## Deadlines and planning
Please fill in the below with you’re the desired dates for your sessions, and then the resulting deadlines for your round. For scheduling the Zoom meetings, please first consult the time availability on the combined agenda availability of the supervisors (ask in channel). Based on this, suggest time slots in the channel, and Gary will send a calendar invitation with a Zoom link.
At the kickoff meeting, we will copy the following into a document in your channel and fill it in together:
Planning of sessions and meetings (fill in date, eg. “Monday Dec 10”)
* Kickoff meeting on Zoom: “...” at XX.XX
* First session: “...” starting at XX.XX
* Second session: “...” starting at XX.XX
* Intermediate report meeting: “...” at XX.XX
* Third session: “...” starting at XX.XX
Deadlines:
* Questions about reading material posted in channel:
* Date: “...”
* Intermediate report slides posted in channel:
* Date: “...”
* First version of report:
* Date: “...”
* Final version of report:
* Date: “...”
## Submitting your report
Please submit the reports via Brightspace, other information can be posted in the channel
## Our expectations of you
The RP is setup with some “core” experiments in which you can observe some of the basic phenomena and get experienced with performing the measurements.
In the documentation, you can find a description of lots of different things you can explore with the setup, and we have tried to express different avenues you can explore if you want and if you have time once you have clearly established and are confident about your analysis the “core” results.
Note, though, that these extra experiments are not necessary for a high grade: doing “extra experiments” but at the same time not mastering an in-depth understanding of the core experiments will result in, if anything, a significantly lower grade. It is more important to us that you really think about what you are doing while you are working, that you are observant, and that you do a robust analysis of the results you obtain.
## Communication
Communication is very important to us: we would rather have more communication that less! The last thing we want is for you to be stuck trying to figure something out for a long time. If you have a question, please, just ask!
How to ask? One place is during the “live support” hours during the lab sessions. Another place is during the discussion of the intermediate report. Then it is easy since you will have us as a captive audience.
BUT PLEASE DO NOT RESTRICT YOUR QUESTIONS TO THESE TWO TIMESLOTS! In particular, please make use of the Teams “channel” for communicating with us whenever you have a question. If you get stuck, don’t wait, JUST POST! We will do our best to answer your question as quickly as we can. And maybe sometimes you answer it yourself before we get back to you: also fine, no problem, just post again saying you figured it out! If you are able to take advantage of the channel to communicate with us fluidly, it will be very beneficial for your experience in this RP.
## Report appendices for the SQUID RP
For this practicum, we will ask specifically for some additional appendices as a minimum:
* Appendix 1: Photographs of your paper logbooks
* Appendix 2: Copy of the “plot all my data” jupyter notebook
* Appendix 3: Code used to generate the plots in your report
* When writing your report, you will write code to make the plots in your report. We will ask that you include this code as Appendix 3.
## Report Writing Guidelines and Advice
We have an additional page where we describe our advice for writing your report.
Report Writing Guidelines and Advice.ipynb 0 → 100644
+ 251
− 0
View file @ 0e1c7174
%% Cell type:markdown id: tags:
# Report Writing Advice and Guidlines
%% Cell type:markdown id: tags:
<h1>Table of Contents<span class="tocSkip"></span></h1>
<div class="toc"><ul class="toc-item"><li><span><a href="#Report-Writing-Advice-and-Guidlines" data-toc-modified-id="Report-Writing-Advice-and-Guidlines-1">Report Writing Advice and Guidlines</a></span><ul class="toc-item"><li><ul class="toc-item"><li><span><a href="#Structure-of-your-report" data-toc-modified-id="Structure-of-your-report-1.0.1">Structure of your report</a></span><ul class="toc-item"><li><span><a href="#Abstract" data-toc-modified-id="Abstract-1.0.1.1">Abstract</a></span></li><li><span><a href="#Introduction" data-toc-modified-id="Introduction-1.0.1.2">Introduction</a></span></li><li><span><a href="#Theory-and-background" data-toc-modified-id="Theory-and-background-1.0.1.3">Theory and background</a></span></li><li><span><a href="#Methods" data-toc-modified-id="Methods-1.0.1.4">Methods</a></span></li><li><span><a href="#Results-&amp;-Discussion" data-toc-modified-id="Results-&amp;-Discussion-1.0.1.5">Results &amp; Discussion</a></span></li><li><span><a href="#Summary-and-outlook" data-toc-modified-id="Summary-and-outlook-1.0.1.6">Summary and outlook</a></span></li></ul></li><li><span><a href="#Report-Writing-Style-Expectations-and-Tips" data-toc-modified-id="Report-Writing-Style-Expectations-and-Tips-1.0.2">Report Writing Style Expectations and Tips</a></span><ul class="toc-item"><li><span><a href="#How-to-write-a-paragraph-in-scientific-writing" data-toc-modified-id="How-to-write-a-paragraph-in-scientific-writing-1.0.2.1">How to write a paragraph in scientific writing</a></span></li><li><span><a href="#LaTeX" data-toc-modified-id="LaTeX-1.0.2.2">LaTeX</a></span></li><li><span><a href="#Math-symbols-and-subscripts" data-toc-modified-id="Math-symbols-and-subscripts-1.0.2.3">Math symbols and subscripts</a></span></li><li><span><a href="#Appropriate-scientific-language-and-statements" data-toc-modified-id="Appropriate-scientific-language-and-statements-1.0.2.4">Appropriate scientific language and statements</a></span></li><li><span><a href="#FIgures" data-toc-modified-id="FIgures-1.0.2.5">FIgures</a></span></li><li><span><a href="#Bullet-point-lists?" data-toc-modified-id="Bullet-point-lists?-1.0.2.6">Bullet point lists?</a></span></li><li><span><a href="#Error-and-estimated-precision" data-toc-modified-id="Error-and-estimated-precision-1.0.2.7">Error and estimated precision</a></span></li><li><span><a href="#Explain-how-you-calculate-your-numberes" data-toc-modified-id="Explain-how-you-calculate-your-numberes-1.0.2.8">Explain how you calculate your numberes</a></span></li></ul></li></ul></li></ul></li></ul></div>
%% Cell type:markdown id: tags:
### Structure of your report
Your report should follow the following overall general structure:
#### Abstract
1-2 sentences background about the experiment and why it is interesting. 2-3 sentences describing objectively what you did, 2-3 sentences explaining to the reader what results were obtained and what conclusions you can draw from them. 1 sentence describing an outlook of what your results mean for future experiments.
#### Introduction
General background information related to the experiments you will do, “painting a backdrop” to your experiment, formulation of the research questions and what you hope to learn from them
You will formulate research questions at the start, but feel free to deviate from those in your report, they are only a starting point. The research questions in your report should be motivated in the end by the conclusions you can draw from your results
#### Theory and background
The theoretical concepts that were required to understand the experimental results. Here, you should think of things that a typical 2nd year student may not yet already know, along with some review of things that are important that they may need to be reminded of
#### Methods
A technical description of the techniques you used for performing the experiments and analyzing the data. How was the data measured? What type of analysis techniques did you use? How did you perform the fitting? What procedure did you follow to extract quantitative numbers from your results for things like the critical current, the critical temperature, etc? Did you perform any data processing like averaging / filtering?
#### Results & Discussion
This is a “Message” oriented chapter. Here you present selected plots and figures to convey a message.
Do not separate the results from the discussion, they need to be kept together!
First, divide this chapter into sections based on the type of experiment and give the sections titles based on what they are about, not what you did. For example: “Observing superconducivity” is a message-based section title. Reading this, the reader knows why they are reading this section. “IV Curve” does not tell a message: it only says what is in the section, not why the reader should read it.
In some sections, you may want to analyze different aspects of that sub-experiment: for this you should use subsections. For example, a subsection of “Observing superconductivity in the SQUID probe” could be “Determining resistance of the superconducting state”, in which you extract the low bias slope of your observed IV curves using a fit. Or “Determining the critical current of the junction”
**How to write results & discussion:** You should base your writing around your figures. First, decide what data you want to present, why you want to present it (what is the “message”), and then make you figure. Once you have the figure, you write:
* First, a caption. The first sentence of the caption is the message, the rest of the caption describes what is shown in the figure adding the important information the reader needs to know in a concise way.
Then, you write three paragraphs (can be merged, but better to separate them at first so it is clear):
* Paragraph 1: Describe what the data is, reminding the reader of any important details of how it was measured that you will need when you provide your interpretation / discussion of the data. This paragraph is objective.
* Paragraph 2: Describe what you see in the data. What happens? Are there any trends that are important? Is there something important to highlight to the reader that you will then discuss when you add your interpretation of the data?
* Paragraph 3: Here, you will provide your own subjective interpretation of the data in the figure and try to convince the reader that your interpretation is correct. You should provide arguments for why you interpret the data in the way you do, and ultimately the reader should finish reading this paragraph and be convinced of your interpretation.
Note the different natures of these paragraphs:
* Paragraphs 1 and 2 are “objective”, you should avoid the use of “we” as much as possible
* Paragraph 3 is subjective, it is your personal interpretation, it is OK to “we” a bit here in your writing:
* “We interpret the deviation in the measurement of critical temperature as …"
#### Summary and outlook
This should contain:
* 1 paragraph summarising your results again, emphasizing what you conclusions you were able to draw
* 1-2 paragraphs discussion about what your results mean for future experiments:
* Are there things that should be investigated further?
* Are there ideas that came out of your report for new experiments to do?
### Report Writing Style Expectations and Tips
For your report, we have certain expectations. We specifically write these down since these are general good practices for scientific writing.
#### How to write a paragraph in scientific writing
Paragraphs: In scientific writing, it is good to make sure that your paragraphs have a proper formal structure
* Gary learned this as the “hamburger paragraph”:
* https://thisreadingmama.com/paragraph-writing-main-idea-details/
* Hamburger paragraphs (with different names) are key to proper academic writing:
* https://www.scribbr.com/research-paper/paragraph-structure/
#### LaTeX
We strongly advise you to use LaTeX when writing using the TU Delft “Report” Template:
https://www.tudelft.nl/en/tu-delft-corporate-design/downloads/
Overleaf is handy in general, and even mega-handy for collaborative writing. We have TU Delft licences now for overleaf, and I strongly encourage you to use it.
#### Math symbols and subscripts
* Write all your sub- and superscripts in non-cursive form (not in Italic).
* In Latex you can use one of the following commands to fix the problem where the equations are automatically written in Italic:
* \mbox{}
* \text{}
* \textrm{}
* \mathrm{}
o Example: $I_{\mathrm{c}}$ --> Ic
#### Appropriate scientific language and statements
Write using precise scientific language!
* Try to be precise and don’t write sentences like: “it is very cold”. Instead, write quantitative stuff when applicable (e.g. “The device has been cooled down to liquid nitrogen temperature (~77K)” or “The temperature of the device is 123.45 K”
* Use decimal points ( . ) and not commas ( , ), e.g. “123.456 K”
* If you know the error of the quantity you are quoting, choose one (or two) significant digits for your error value and quote the value to the same precision (number of decimal places) as the resulting error value
* If you do not have sufficient data to make a meaningful statement about the error, choose a number of digits you think is appropriate and provide a short discussion of how you made this choice
* Avoid writing that stuff is “hard”, “difficult” or “easy”
#### FIgures
Figure tips:
##### PDF only, no PNG / JPG / etc!
* Do not use screenshots for plots of your data! Use PDFs generated by your analysis software (eg. Python)
* Screenshots for illustrating details of how you used the software are OK, if you feel it is useful / important to explain how you used the software
* Save figures as .pdf file and not .png (or .jpeg). PDF-figures in Latex/pdf generated reports will look sharper. In python:
* fig.savefig("fig.pdf")
* Pictures from the experiment and of your exact setup are strongly encouraged, and of course can be included as JPG / PNG in your report
##### Zoom to make clear what aspect you want the reader to look at
* When plotting your data for discussion, chose a “zoomed” axis range if it helps explain your point
* For example: if you took a data trace up to 300K and want to discuss the temperature dependence of the resistance, it might make sense to include the temperature range you measured in the plot
* But if you want to discuss the transition temperature, it makes more sense to restrict your plot to a range of temperature near Tc
##### Labels!
* Label all your axes with all of the following:
* A few (1-3 word) description (eg. Bias current)
* A mathematical symbol you define in the text (eg. Ib)
* A unit (eg. ?A)
##### Legends
* Use legends when plotting multiple data sets with
* If possible, a mathematical symbol and value you define in the caption, eg “Ib = 1 ?A”
* Optional short descriptions (1-2 word) in the legend text if they fit
##### Lines or points?
Should I use lines or points or lines connected with points for plotting data?
* If you have “dense” data with lots of points (like an IV curve), and you have no analytical lines in your plot, then use lines
* If you have data and a fit / analytical formula in the same plot:
* Plot the data with symbols and no lines connecting them
If your data is dense, like an IV curve, use small dots (python matplotlib plt.plot(x, y, ”.”)
* Plot the analytical formula, like a fit or a guide to the eye, with a line, mentioning the formula in the caption
* If you have “not very dense data”, such that the default symbol size would not overlap when you make the plot, then use only symbols
* These are most likely for data that you are “consolidating” from sequences of measurements, like say plotting a fit parameter vs temperature from raw datasets (I'm not sure if there really are any in this practicum, but it could come up depending on what you do for the data analysis). In this case, you most likely also have error bars for each data point, and these should also be included.
##### How to put figures in my report
* If you have two panels, put them side-by-side (matplotlib subplot(121)) and make them the full width of the text
* If you have one figure, make at least +/- 60% of the text width
* Center all figures on the page
* Figure caption should be left justified, not centered
##### Font sizes!
Font in figures should be large enough for the reader to write it
* If you measure it with a ruler, minimum font size should be 3 mm tall for a capital letter (9 point)
* Also think about how visible colours are to your reader as well
##### Make your own figures!!!!
Do not include figures based on the supplied “automated” plotting routines in the main chapters of the report
* These are things that we provide for you to quickly be able to plot and analyze your data while you’re working
* For the figures in the report, we expect that you spend time to think about what the figure contents should be based on the message you want that figure to convey
* You are welcome to look at how we make these plots and reuse this code in your own plots, but the figures they make are not suitable for direct inclusion in the report
* There is also some code that shows you how to load and plot the data from the created data files
* As mentioned above, we do expect you to put a copy of the code you write for making the figures you include in the report in the appendeix
* If you make a claim in your text, always back it up with either data or a reference (book, paper, etc.)
* Write your research questions in the introduction chapter of your report
#### Bullet point lists?
You can write things your research questions as bullet points. This can be useful to provide a visually identifyable summary, but there should be some part of your report (preferably before or nearby the list) that explains a bit at least what the bullet points mean.
#### Error and estimated precision
Whenever possible, include the uncertainty in the numbers you quote: eg. 123.45 ± 0.05 Ω. You should include on "sigificant digit" in the error values, and quote the measured value to an accuracy of that significant digit.
When quoting error values, you should explain where the precision estimate comes from. If you have a statistical origin of your uncertianty (like parameter error from a least-squares fit), you should state this (and include the code). If you get it from some other way of estimating it, explain in words what you did.
#### Explain how you calculate your numberes
In your report, you must show, or tell, how you calculated your numbers or data when you discuss it.
* If this text because too large or interrupts the flow of your story significantly then you can include only a short description in your report main text, place the full details in your appendix or methods section, and reference it when discussion.
Report Writing Guidelines and Advice.md 0 → 100644
+ 212
− 0
View file @ 0e1c7174
---
jupyter:
jupytext:
formats: ipynb,md
text_representation:
extension: .md
format_name: markdown
format_version: '1.3'
jupytext_version: 1.10.1
kernelspec:
display_name: Python 3
language: python
name: python3
---
# Report Writing Advice and Guidlines
<!-- #region toc=true -->
<h1>Table of Contents<span class="tocSkip"></span></h1>
<div class="toc"><ul class="toc-item"><li><span><a href="#Report-Writing-Advice-and-Guidlines" data-toc-modified-id="Report-Writing-Advice-and-Guidlines-1">Report Writing Advice and Guidlines</a></span><ul class="toc-item"><li><ul class="toc-item"><li><span><a href="#Structure-of-your-report" data-toc-modified-id="Structure-of-your-report-1.0.1">Structure of your report</a></span><ul class="toc-item"><li><span><a href="#Abstract" data-toc-modified-id="Abstract-1.0.1.1">Abstract</a></span></li><li><span><a href="#Introduction" data-toc-modified-id="Introduction-1.0.1.2">Introduction</a></span></li><li><span><a href="#Theory-and-background" data-toc-modified-id="Theory-and-background-1.0.1.3">Theory and background</a></span></li><li><span><a href="#Methods" data-toc-modified-id="Methods-1.0.1.4">Methods</a></span></li><li><span><a href="#Results-&amp;-Discussion" data-toc-modified-id="Results-&amp;-Discussion-1.0.1.5">Results &amp; Discussion</a></span></li><li><span><a href="#Summary-and-outlook" data-toc-modified-id="Summary-and-outlook-1.0.1.6">Summary and outlook</a></span></li></ul></li><li><span><a href="#Report-Writing-Style-Expectations-and-Tips" data-toc-modified-id="Report-Writing-Style-Expectations-and-Tips-1.0.2">Report Writing Style Expectations and Tips</a></span><ul class="toc-item"><li><span><a href="#How-to-write-a-paragraph-in-scientific-writing" data-toc-modified-id="How-to-write-a-paragraph-in-scientific-writing-1.0.2.1">How to write a paragraph in scientific writing</a></span></li><li><span><a href="#LaTeX" data-toc-modified-id="LaTeX-1.0.2.2">LaTeX</a></span></li><li><span><a href="#Math-symbols-and-subscripts" data-toc-modified-id="Math-symbols-and-subscripts-1.0.2.3">Math symbols and subscripts</a></span></li><li><span><a href="#Appropriate-scientific-language-and-statements" data-toc-modified-id="Appropriate-scientific-language-and-statements-1.0.2.4">Appropriate scientific language and statements</a></span></li><li><span><a href="#FIgures" data-toc-modified-id="FIgures-1.0.2.5">FIgures</a></span></li><li><span><a href="#Bullet-point-lists?" data-toc-modified-id="Bullet-point-lists?-1.0.2.6">Bullet point lists?</a></span></li><li><span><a href="#Error-and-estimated-precision" data-toc-modified-id="Error-and-estimated-precision-1.0.2.7">Error and estimated precision</a></span></li><li><span><a href="#Explain-how-you-calculate-your-numberes" data-toc-modified-id="Explain-how-you-calculate-your-numberes-1.0.2.8">Explain how you calculate your numberes</a></span></li></ul></li></ul></li></ul></li></ul></div>
<!-- #endregion -->
<!-- #region -->
### Structure of your report
Your report should follow the following overall general structure:
#### Abstract
1-2 sentences background about the experiment and why it is interesting. 2-3 sentences describing objectively what you did, 2-3 sentences explaining to the reader what results were obtained and what conclusions you can draw from them. 1 sentence describing an outlook of what your results mean for future experiments.
#### Introduction
General background information related to the experiments you will do, “painting a backdrop” to your experiment, formulation of the research questions and what you hope to learn from them
You will formulate research questions at the start, but feel free to deviate from those in your report, they are only a starting point. The research questions in your report should be motivated in the end by the conclusions you can draw from your results
#### Theory and background
The theoretical concepts that were required to understand the experimental results. Here, you should think of things that a typical 2nd year student may not yet already know, along with some review of things that are important that they may need to be reminded of
#### Methods
A technical description of the techniques you used for performing the experiments and analyzing the data. How was the data measured? What type of analysis techniques did you use? How did you perform the fitting? What procedure did you follow to extract quantitative numbers from your results for things like the critical current, the critical temperature, etc? Did you perform any data processing like averaging / filtering?
#### Results & Discussion
This is a “Message” oriented chapter. Here you present selected plots and figures to convey a message.
Do not separate the results from the discussion, they need to be kept together!
First, divide this chapter into sections based on the type of experiment and give the sections titles based on what they are about, not what you did. For example: “Observing superconducivity” is a message-based section title. Reading this, the reader knows why they are reading this section. “IV Curve” does not tell a message: it only says what is in the section, not why the reader should read it.
In some sections, you may want to analyze different aspects of that sub-experiment: for this you should use subsections. For example, a subsection of “Observing superconductivity in the SQUID probe” could be “Determining resistance of the superconducting state”, in which you extract the low bias slope of your observed IV curves using a fit. Or “Determining the critical current of the junction”
**How to write results & discussion:** You should base your writing around your figures. First, decide what data you want to present, why you want to present it (what is the “message”), and then make you figure. Once you have the figure, you write:
* First, a caption. The first sentence of the caption is the message, the rest of the caption describes what is shown in the figure adding the important information the reader needs to know in a concise way.
Then, you write three paragraphs (can be merged, but better to separate them at first so it is clear):
* Paragraph 1: Describe what the data is, reminding the reader of any important details of how it was measured that you will need when you provide your interpretation / discussion of the data. This paragraph is objective.
* Paragraph 2: Describe what you see in the data. What happens? Are there any trends that are important? Is there something important to highlight to the reader that you will then discuss when you add your interpretation of the data?
* Paragraph 3: Here, you will provide your own subjective interpretation of the data in the figure and try to convince the reader that your interpretation is correct. You should provide arguments for why you interpret the data in the way you do, and ultimately the reader should finish reading this paragraph and be convinced of your interpretation.
Note the different natures of these paragraphs:
* Paragraphs 1 and 2 are “objective”, you should avoid the use of “we” as much as possible
* Paragraph 3 is subjective, it is your personal interpretation, it is OK to “we” a bit here in your writing:
* “We interpret the deviation in the measurement of critical temperature as …"
#### Summary and outlook
This should contain:
* 1 paragraph summarising your results again, emphasizing what you conclusions you were able to draw
* 1-2 paragraphs discussion about what your results mean for future experiments:
* Are there things that should be investigated further?
* Are there ideas that came out of your report for new experiments to do?
### Report Writing Style Expectations and Tips
For your report, we have certain expectations. We specifically write these down since these are general good practices for scientific writing.
#### How to write a paragraph in scientific writing
Paragraphs: In scientific writing, it is good to make sure that your paragraphs have a proper formal structure
* Gary learned this as the “hamburger paragraph”:
* https://thisreadingmama.com/paragraph-writing-main-idea-details/
* Hamburger paragraphs (with different names) are key to proper academic writing:
* https://www.scribbr.com/research-paper/paragraph-structure/
#### LaTeX
We strongly advise you to use LaTeX when writing using the TU Delft “Report” Template:
https://www.tudelft.nl/en/tu-delft-corporate-design/downloads/
Overleaf is handy in general, and even mega-handy for collaborative writing. We have TU Delft licences now for overleaf, and I strongly encourage you to use it.
#### Math symbols and subscripts
* Write all your sub- and superscripts in non-cursive form (not in Italic).
* In Latex you can use one of the following commands to fix the problem where the equations are automatically written in Italic:
* \mbox{}
* \text{}
* \textrm{}
* \mathrm{}
o Example: $I_{\mathrm{c}}$ --> Ic
#### Appropriate scientific language and statements
Write using precise scientific language!
* Try to be precise and don’t write sentences like: “it is very cold”. Instead, write quantitative stuff when applicable (e.g. “The device has been cooled down to liquid nitrogen temperature (~77K)” or “The temperature of the device is 123.45 K”
* Use decimal points ( . ) and not commas ( , ), e.g. “123.456 K”
* If you know the error of the quantity you are quoting, choose one (or two) significant digits for your error value and quote the value to the same precision (number of decimal places) as the resulting error value
* If you do not have sufficient data to make a meaningful statement about the error, choose a number of digits you think is appropriate and provide a short discussion of how you made this choice
* Avoid writing that stuff is “hard”, “difficult” or “easy”
#### FIgures
Figure tips:
##### PDF only, no PNG / JPG / etc!
* Do not use screenshots for plots of your data! Use PDFs generated by your analysis software (eg. Python)
* Screenshots for illustrating details of how you used the software are OK, if you feel it is useful / important to explain how you used the software
* Save figures as .pdf file and not .png (or .jpeg). PDF-figures in Latex/pdf generated reports will look sharper. In python:
* fig.savefig("fig.pdf")
* Pictures from the experiment and of your exact setup are strongly encouraged, and of course can be included as JPG / PNG in your report
##### Zoom to make clear what aspect you want the reader to look at
* When plotting your data for discussion, chose a “zoomed” axis range if it helps explain your point
* For example: if you took a data trace up to 300K and want to discuss the temperature dependence of the resistance, it might make sense to include the temperature range you measured in the plot
* But if you want to discuss the transition temperature, it makes more sense to restrict your plot to a range of temperature near Tc
##### Labels!
* Label all your axes with all of the following:
* A few (1-3 word) description (eg. Bias current)
* A mathematical symbol you define in the text (eg. Ib)
* A unit (eg. ?A)
##### Legends
* Use legends when plotting multiple data sets with
* If possible, a mathematical symbol and value you define in the caption, eg “Ib = 1 ?A”
* Optional short descriptions (1-2 word) in the legend text if they fit
##### Lines or points?
Should I use lines or points or lines connected with points for plotting data?
* If you have “dense” data with lots of points (like an IV curve), and you have no analytical lines in your plot, then use lines
* If you have data and a fit / analytical formula in the same plot:
* Plot the data with symbols and no lines connecting them
If your data is dense, like an IV curve, use small dots (python matplotlib plt.plot(x, y, ”.”)
* Plot the analytical formula, like a fit or a guide to the eye, with a line, mentioning the formula in the caption
* If you have “not very dense data”, such that the default symbol size would not overlap when you make the plot, then use only symbols
* These are most likely for data that you are “consolidating” from sequences of measurements, like say plotting a fit parameter vs temperature from raw datasets (I'm not sure if there really are any in this practicum, but it could come up depending on what you do for the data analysis). In this case, you most likely also have error bars for each data point, and these should also be included.
##### How to put figures in my report
* If you have two panels, put them side-by-side (matplotlib subplot(121)) and make them the full width of the text
* If you have one figure, make at least +/- 60% of the text width
* Center all figures on the page
* Figure caption should be left justified, not centered
##### Font sizes!
Font in figures should be large enough for the reader to write it
* If you measure it with a ruler, minimum font size should be 3 mm tall for a capital letter (9 point)
* Also think about how visible colours are to your reader as well
##### Make your own figures!!!!
Do not include figures based on the supplied “automated” plotting routines in the main chapters of the report
* These are things that we provide for you to quickly be able to plot and analyze your data while you’re working
* For the figures in the report, we expect that you spend time to think about what the figure contents should be based on the message you want that figure to convey
* You are welcome to look at how we make these plots and reuse this code in your own plots, but the figures they make are not suitable for direct inclusion in the report
* There is also some code that shows you how to load and plot the data from the created data files
* As mentioned above, we do expect you to put a copy of the code you write for making the figures you include in the report in the appendeix
* If you make a claim in your text, always back it up with either data or a reference (book, paper, etc.)
* Write your research questions in the introduction chapter of your report
#### Bullet point lists?
You can write things your research questions as bullet points. This can be useful to provide a visually identifyable summary, but there should be some part of your report (preferably before or nearby the list) that explains a bit at least what the bullet points mean.
#### Error and estimated precision
Whenever possible, include the uncertainty in the numbers you quote: eg. 123.45 ± 0.05 Ω. You should include on "sigificant digit" in the error values, and quote the measured value to an accuracy of that significant digit.
When quoting error values, you should explain where the precision estimate comes from. If you have a statistical origin of your uncertianty (like parameter error from a least-squares fit), you should state this (and include the code). If you get it from some other way of estimating it, explain in words what you did.
#### Explain how you calculate your numberes
In your report, you must show, or tell, how you calculated your numbers or data when you discuss it.
* If this text because too large or interrupts the flow of your story significantly then you can include only a short description in your report main text, place the full details in your appendix or methods section, and reference it when discussion.
<!-- #endregion -->
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment