Differences

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

--- en:praktikum:protocol [2017/04/10 01:26] – created rhainich
+++ en:praktikum:protocol [2026/04/23 06:12] (current) – rhainich
@@ Line 1: / Line 1: @@
-===== How to write a lab course protocol =====
+====== How to Write a Lab Report ======
-Here we give a few advices regarding the writing of a standard protocol within the scope of the astrophysical lab course. It should give an overview over what should be included in those protocols and which guidelines need to be followed.
+Here we provide some basic guidelines for writing lab reports. The guidelines are kept general and offer a framework for writing reports. Many of them are analogous to the general criteria for writing scientific texts, such as Bachelor's and Master's theses or scientific publications.
-A typical protocol should consist of the following sections:
+===== General Guidelines =====
-  * a theoretical part that explains the background need to understand the topic of the protocol
-  * a general description of the observation, the data reduction, and the data analysis
-  * the presentation of the results
-  * a discussion of the results with respect to literature values, uncertainties, and possible error sources
-  * a list with references
+A scientific text generally serves two important functions:
+  - **Presentation of results and conclusions.** This is the fundamental message you want to convey to the readers. All the important (new) information and ideas need to be included.
+  - **Transparency and reproducibility of results.** Scientific findings only have value if they are reproducible. Write your text in a way that allows others to follow your steps and reproduce your results using your data. This strengthens the credibility and persuasiveness of your findings. In the context of a lab report, this is also important for us to assess how well you have engaged with the topic and understood the details.
+//These two points are of particular importance in the evaluation of the lab report.//
+===== Structure and Content of a Lab Report =====
+A typical lab report is divided into the following sections:
+  - A brief **introduction** that leads into the topic (**can be kept very short in the age of AI**).
+  - A section on the **theoretical background**, laying out all the scientific foundations needed to understand the results and conclusions and to follow their derivation (**can be kept very short in the age of AI**).
+  - A general description of the **observational data**, often together with the **data reduction**, describing how the raw data are processed into reduced data products. The acquisition of the raw data is also described here.
+  - A presentation of the **results**, including the final data products and direct measurements from the data.
+  - The **data analysis** covers all quantities derived from the results. This includes more extensive calculations based on models and assumptions, as well as derivations of broader relationships and model comparisons.
+  - The **discussion** places the results of the analysis and measurements in a scientific context. The results are examined with regard to their plausibility and possible measurement uncertainties. Potential sources of error are addressed, as well as a comparison with similar experiments from the literature.
+  - A **references** section lists all literature sources used in the course of writing the report, including sources for adapted figures as well as literature values used for assumptions and comparisons.
+  - An **appendix** contains any additional information and figures that are too important to omit but would disrupt the flow of the main text too much.
+This is a general overview applicable to most types of scientific texts. Depending on the content or context of the report, however, deviations from this structure may be useful or even necessary to improve readability.
+===== Further Advice =====
 /*
-A few general comments to your protocols:
+  * A report is a lengthy text and can be demanding to write. One often becomes blind to one's own mistakes or omissions. Make use of the fact that you are writing the report as a group and proofread each other's sections. It can also be helpful to set a written text aside for a day or two and then read it again with fresh eyes. This makes it much easier to spot spelling mistakes, missing words, repetitions, or gaps.
+*/
+  * When thinking about what to include in your report, follow this principle: What does a reader need in order to understand the results and conclusions? What is necessary for a reader to be able to reproduce your steps and, if applicable, understand any deviations from expectations?
+  * Write in your own words. The lab course supervisors have read dozens of reports and will immediately notice if a text has been written entirely by an AI, for example. If a report is written exclusively by an AI or copied from another source without being clearly marked as such, this will be considered an attempt at plagiarism and will result in immediate disqualification.
+  * An example of a good, though not perfect, lab report for N2 can be found {{en:labcourse:n2_shenar_guber.pdf|here}}. (With thanks to Tomer Shenar and Christoph Guber for providing the report.)
-* please first describe the theoretical part before you write about your
+===== Lab Report Template =====
-  results
-* please shortly describe what you have done during the observation, the
-  data reduction, and the data analysis (this part was significantly too
-  short or absent in your protocols)
-* please include your images in the protocol
-* please include the figures from the data reduction in the protocol
-  - only one example of each type is needed in the main part of the
-    protocol
-  - refer to this figures when describing the data reduction
-  - additional figures should be attached as an appendix
-* discuss your results in terms of plausibility and possible errors
-* compare your results with values from the literature (give references
-  for these values)
-* if you use figures reference them in the text
-* state the origin of each figure that is not made by yourself
-* only use bullet points where it benefits the reading flow
+To support you, we have prepared a LaTeX template for a lab report. The template is written in LaTeX and should compile without issues using a standard LaTeX installation. A {{en:labcourse:reports:report_template.zip|zipped archive}} contains all necessary source files, including the template to be edited as well as additional files required for successful compilation. The archive contains the following files:
-A few specific comments:
+^ Filename                ^ Purpose                                                                              ^ To be edited by you?    ^
+| lab_report_empty.tex    | The empty template for you to fill in                                                | yes                     |
+| bibliography.bib        | Contains BibTeX entries for all cited sources                                        | yes                     |
+| aa.bst                  | BibTeX style file determining the appearance of references                           | no                      |
+| lab_report.tex          | Source file for the guide (see below)                                                | no                      |
+| bibdefinitions.tex      | Predefined LaTeX commands for astronomical journals (used for BibTeX)                | no                      |
-N1:
+All other files are generated automatically during compilation.
-* please remove the red continuum line from your plots
+Based on this template, we have written a {{en:labcourse:reports:report_template.pdf|short guide}} that provides advice on how to write a lab report. It is somewhat more comprehensive than what is written here and additionally contains general instructions on typesetting, scientific writing, and a list of useful LaTeX commands.
-* please remove implausible line identifications
-* please discuss (on the basis of your spectra) why or why not the
-  spectral types assigned to the individual stars are plausible
-* for all stars, please attache the plots that show all observed orders to
-  the end of your protocol
-N2:
-* please discuss why the chosen isochrones do fit best (Why didn't you
-  used a different one?)
-* please discuss possible errors/uncertainties (e.g. Why couldn’t you see
-  more of the main sequence?)
-*/