Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example lab report #409

Closed
wants to merge 50 commits into from
Closed

Example lab report #409

wants to merge 50 commits into from

Conversation

LuckyJosh
Copy link
Contributor

@LuckyJosh LuckyJosh commented Sep 18, 2024

First 4 days are done

the next 5 are WORK IN PROGRESS

To have a more or less realistic example report, I conducted a series of experiments (objects rolling down an inclined plane)
and wrote an almost[1] complete lab report for it.

The overall idea is to have not only a somewhat realistic example but also building up this example.
Currently the final report is done and I'm going to split the final result into pieces,
that can be done as progressive exercises (essentially recreating the template piece by piece) with the final report as a comparison.

My rough idea of the steps are:

  • Day 1: Python
    • Setup the folder an a python script
    • Some calculations with loops?
  • Day 2: Numpy, Matplotlib
    • loading data with numpy
    • calculations with numpy
    • adding the plots (without fits)
  • Day 3: Scipy, uncertainties
    • adding the fits
    • adding uncertainties
  • Day 4: unix, git
    • turning the folder into a git repo (doing git stuff, push to github ...)
  • Day 5: LaTeX-intro
    • adding a first version of the document (maybe all in one file)
    • splitting it up into multiple files
  • Day 6: LaTeX-Math
    • Adding the equations to the respective sections
  • Day 7: LaTeX-Floats and Bibliography
    • Adding the plots as figures
    • Adding the tables by typing them out (not via the script)
    • Adding the sources to the bib files
  • Day 8: LaTeX + Matplotlib
    • adding header-matplotlib and matplotlibrc
  • Day 9: Make
    • Adding the Makefile

[1] All sections do contain some 'real-world' examples for tables, images, equations
(single and multiline), and references to any of these. And the overall structure fits as well, but I did not find anything to write in the discussion section, that would make the example any better
(I just left a todo note).

@jpwgnr
Copy link

jpwgnr commented Sep 18, 2024

krass

Objekte (eine Kugel und Holzylinder in Form eines Glases) eine schiefe Ebene hinab gerollt.

Notiert wird dabei die Starthöhen $h$. Der Prozess des Herabrollens wird mit einer Kamera
aufgezeichnet, um aus die Zeit $t$ bis zum erreichen des Endes der schiefen Ebene möglichst genau
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

um aus die Zeit

if np.any(stds([num])):
if figures is None:
figures = ""
x = "{0:.{1:}uf}".format(num, figures).replace("/", "")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would always choose for f-strings at this point and I think they are more "modern" and here they claim they are faster than .format

\begin{table}
\centering
\input{build/table_averaged-measurements.tex}
\caption{Für gleiche Starthöhe $h$ gemittelte Messwerte der Zeit $t$.}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are table captions not usually above the content?

\draw[dashed,opacity=0.25] (3.,0.26) circle (0.25cm);
\draw[->] (0.25, 1.03) arc (270:50:0.16) node[below]{\small$\omega$};
\end{tikzpicture}
\caption{Schematische Darstellung des Versuchsaufbaus.}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a couple more words on what is actually shown here

\label{eq:physical-properties}
m_\text{Z} &= \input{mass_ball.tex} & m_\text{K} &= \input{mass_ball.tex}\nonumber\\
r_{\text{Z},\text{i}} &= \input{../build/radius-inner_cylinder.tex} & r_\text{K} &= \input{radius_ball.tex}\\
r_{\text{Z},\text{a}} &= \input{../build/radius-outer_cylinder.tex} &&\nonumber
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is a period missing in the end of theis list, no? not exactly sure how these should formatted in the best possible way

\end{align}

Berechnet wurde aus diesen Größen das jeweilige, theoretiche Trägheitsmoment

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not leave blank lines between equation and alignment environments, this creates weird spaces


\begin{align}
\label{eq:moments-inertia}
I_\text{Z} &= \input{./../build/theoretical-I_cylinder.tex} && I_\text{K} = \input{./../build/theoretical-I_ball.tex}.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I would add a comma in here between the values

Copy link

@jpwgnr jpwgnr Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also these values I would probably format in kg mm^2 as these have now many zeros which is not scientifically accurate


Aus den aufgenommenen Videos der Versuche wurden die in \autoref{tab:all-measurements} folgenden Frameindizes extrahiert.
Die ebenfalls aufgeführte Zeitdauer $t$ wurde dann jeweils aus der aus dem Startframeindex $F_\text{i}$,
dem Endframeindex $F_\text{f}$ und der Kameraframerate $\symup{fps}=\input{framerate.tex}$ wie folgt
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here I would have the framerate unit with a per-mode=reciprocal

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

symup is the wrong command for fps, it still treats it as f • p • s, just upright.

Correct would be operatorname

\end{table}

Durch Mittelung der Messwerte für die selbe Höhe $h$ ergeben sich die in
\autoref{tab:averaged-measurements} berechnet und werden für die folgenden
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"ergeben sich die in Tabelle 2 berechnet" here is something weird

@jpwgnr
Copy link

jpwgnr commented Sep 18, 2024

couple of small things to improve, all in all it is really a beautiful example! Well done.

@LuckyJosh
Copy link
Contributor Author

couple of small things to improve, all in all it is really a beautiful example! Well done.

Thanks for the review 👍

@LuckyJosh
Copy link
Contributor Author

The first 4 days of 'steps' towards the protocol are now done.

@LuckyJosh LuckyJosh changed the title WIP: Example lab report Example lab report Sep 23, 2024
@LuckyJosh
Copy link
Contributor Author

Thinking about this, I don't like:

  • how big this PR is right now (and going to be) and
  • that multiple files are duplicated

I'll post the todo list as an issue and going to change the structure of this PR in a new one.

@LuckyJosh LuckyJosh closed this Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants