en:praktikum:protocol

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
en:praktikum:protocol [2021/07/29 10:54] – dagruneren:praktikum:protocol [2021/09/21 15:21] (current) – dagruner
Line 1: Line 1:
 ===== How to write a lab course report ===== ===== How to write a lab course report =====
  
-Here we give a few advises regarding the writing of a report within the scope of the astrophysical lab course. We aim to give an overview over what should be included in those reports and which guidelines need to be followed. Those largely are similar to the requirements of future scientific writings like thesises and journal papers.+Here we give a few advises regarding the writing of a report within the scope of the astrophysical lab course. We aim to give an overview over what should be included in those reports and which guidelines need to be followed. Those largely are similar to the requirements of future scientific writings like theses and journal papers.
  
 **General Notes** **General Notes**
Line 7: Line 7:
 A scientific text has two important purposes: A scientific text has two important purposes:
   - //Presentation of your results, findings, and conclusions.// This is the fundamental message that you want to convey, you describe and show all of your findings. This is the part that contains what others should learn from your work.   - //Presentation of your results, findings, and conclusions.// This is the fundamental message that you want to convey, you describe and show all of your findings. This is the part that contains what others should learn from your work.
-  - //Transparency and reproducability of the results.// This includes a clear and precise description of the process you obtained your results with. Write under the assumption that a potential reader schould be able to reproduce your results from your data while following your steps. This gives credibility to your results. For a lab report, it allows us to identify potential problems that occured throughout the process and see how well you understood the work you did.+  - //Transparency and reproducibility of the results.// This includes a clear and precise description of the process you obtained your results with. Write under the assumption that a potential reader should be able to reproduce your results from your data while following your steps. This gives credibility to your results. For a lab report, it allows us to identify potential problems that occurred throughout the process and see how well you understood the work you did.
  
  
Line 20: Line 20:
   - A **discussion** of the results of the analysis with respect to literature values, plausibility, uncertainties, and possible error sources   - A **discussion** of the results of the analysis with respect to literature values, plausibility, uncertainties, and possible error sources
   - A list of **references** used throughout the report. This includes values for literature comparisons but also adopted literature values for the results and analysis part. The same goes for figures that you use from books or webpages.   - A list of **references** used throughout the report. This includes values for literature comparisons but also adopted literature values for the results and analysis part. The same goes for figures that you use from books or webpages.
-  - An ***appendix** that contains all suplementary informations, additional figures, etc. +  - An ***appendix** that contains all supplementary information, additional figures, etc. 
  
 +This is just a general structure, valid for most writings. Given the content of the report, individual points can be merged or even omitted. Also the order may change in specific cases when the content demands/merits it.
  
 **More remarks** **More remarks**
  
-  * It can be exhausting writing on a lengthy text over time. One gets blind for their own mistakes over time, things that made sense in your head may when they are on paper. Leverage that you write this as a group, proof read each others contributions. Also, put the text to rest for one or two days and reread it to identify problems with the structure or wording, and find repitions or gaps to be filled in the text. +  * It can be exhausting writing on a lengthy text over time. One gets blind for their own mistakes over time, things that made sense in your head may not when they are on paper. Leverage that you write this as a group, proof read each others contributions. Also, put the text to rest for one or two days and reread it to identify problems with the structure or wording, and find repetitions or gaps to be filled in the text. 
-  * When thinking about what to include in your report as information, act according to this princinple: what does someone need to know to understand your findings and the way you reach there, and information do they need to be able to retrace your steps with your data to reproduce your results?+  * When thinking about what to include in your report as information, act according to this principle: what does someone need to know to understand your findings and the way you reach there? Which information do they need to be able to retrace your steps with your data to reproduce your results?
   * Use your own words to describe things. Please be aware that the supervisors (which will evaluate your report) already read dozens of other reports. Hence, they will immediately recognize whether you have copied text from e.g. the Internet, which is considered to be a plagiarism and which will result in an immediate disqualification.    * Use your own words to describe things. Please be aware that the supervisors (which will evaluate your report) already read dozens of other reports. Hence, they will immediately recognize whether you have copied text from e.g. the Internet, which is considered to be a plagiarism and which will result in an immediate disqualification. 
   * An example for a good, although not perfect, N2 report can be found {{en:labcourse:n2_shenar_guber.pdf|here}} (many thanks to Tomer Shenar and Christoph Guber for providing this file).   * An example for a good, although not perfect, N2 report can be found {{en:labcourse:n2_shenar_guber.pdf|here}} (many thanks to Tomer Shenar and Christoph Guber for providing this file).
  
-**OLD BELOW**+**Report template** 
 + 
 +We have created a report template for you to use. It is written in Latex and you should be able to compile it with a typicla Latex installation. A {{en:labcourse:reports:report_template.zip|zipped source files directory}} contains all necessary files, including the template for you to edit, and all auxillary files needed for the succesfull compilation. The files are as follows: 
 + 
 +^ File name               ^ Purpose                                                                              ^  edit by you?   ^ 
 +| lab_report_empty.tex    | The empty lab report template for you to fill                                        |  yes            | 
 +| bibliography.bib        | Contains bibtex entries for everything you reference                                 |  yes            | 
 +| aa.bst                  | Bibtex style file that determines how references look like                           |  no             | 
 +| lab_report.tex          | Source file for guide (see below)                                                    |  no             | 
 +| bibdefinitions.tex      | Predefined definitions for typical Astronomy journal references (needed for bibtex)  |  no             | 
 +  
 +All other files are created by the compilation. lab_report.pdf is the compiled report. 
 + 
 +Based on this template, we wrote a {{en:labcourse:reports:report_template.pdf|little guide}} on how to write lab reports and on the required contents for the indivdiual experiments that extends the information given here. It also describes some general typesetting and writing conventions for scientific documents as well as helpful Latex commands. 
 + 
 + 
 + 
 +/* **OLD BELOW**
  
 Here we give a few advises regarding the writing of a report within the scope of the astrophysical lab course. We aim to give an overview over what should be included in those reports and which guidelines need to be followed. Here we give a few advises regarding the writing of a report within the scope of the astrophysical lab course. We aim to give an overview over what should be included in those reports and which guidelines need to be followed.
Line 47: Line 65:
   * the report should include the figures from the data reduction, however only one example of each type is needed in the main part of the report, additional figures should be attached as an appendix   * the report should include the figures from the data reduction, however only one example of each type is needed in the main part of the report, additional figures should be attached as an appendix
  
-An example for a good, although not perfect, N2 report can be found {{en:labcourse:n2_shenar_guber.pdf|here}} (many thanks to Tomer Shenar and Christoph Guber for providing this file).+An example for a good, although not perfect, N2 report can be found {{en:labcourse:n2_shenar_guber.pdf|here}} (many thanks to Tomer Shenar and Christoph Guber for providing this file).*/
  • en/praktikum/protocol.1627556085.txt.gz
  • Last modified: 2021/07/29 10:54
  • by dagruner