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

Progress on: example lab report #419

Open
11 tasks done
LuckyJosh opened this issue Sep 23, 2024 · 2 comments
Open
11 tasks done

Progress on: example lab report #419

LuckyJosh opened this issue Sep 23, 2024 · 2 comments

Comments

@LuckyJosh
Copy link
Contributor

LuckyJosh commented Sep 23, 2024

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.

See PR #448 for the actual implementation.

Revised list of the steps (added more steps, so that they are quite specific and not to cramped):

  • Step 1 (after topic: python):
    • Setup the folder and a python script
    • Some calculations with loops?
  • Step 2 (after topic: numpy):
    • loading data with numpy
    • calculations with numpy
  • Step 3 (after topic: matplotlib):
    • adding the plots of data and theory function (without fits)
  • Step 4 (after topic: scipy): Scipy
    • adding the fits
  • Step 5 (after topic: uncertainties)
    • adding uncertainties ⇒ updating dataloading/-processing, fitting, plotting
  • Step 6 (after topic: git):
    • turning the folder into a git repo (doing git stuff, push to github ...)
    • move v16516 specific files into a folder, i.e. a subfolder in the git-repo
  • Step 7 (after topic: latex intro):
    • adding a first version of the document ⇒ sections and \input{content/...}
  • Step 8 (after topic: latex math):
    • adding all math to the respective sections
  • Step 9 (after topic: floats, refs and bib):
    • Adding the plots as figures
    • Adding the tables by typing them out (not via the python script)
    • Adding the sources to the bib files
  • Step 10 (after topic: latex + matplotlib ):
    • move v16516 specific files into a folder [→ Step 6]
    • adding header-matplotlib and matplotlibrc
    • Adding a Makefile:
      • use build/ for each outputfile
  • Step 11 (advanced improvements):
    • generating more output files:
      • no hardcoded numbers in the tex files
      • no handcrafted tables

[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).

@chrbeckm
Copy link
Member

chrbeckm commented Oct 3, 2024

In the future, we could import the wrapper scripts for ucurve_fit, from the uncertainties exercise and use them as well.

@LuckyJosh
Copy link
Contributor Author

In the future, we could import the wrapper scripts for ucurve_fit, from the uncertainties exercise and use them as well.

Yes that is part of step-11

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

No branches or pull requests

2 participants