Rapportskrivning En introduktion till rapportskrivning och Latex på civilingenjörsprogrammet i Teknisk fysik. Jonathan Dartland

En presentation över ämnet: "Rapportskrivning En introduktion till rapportskrivning och Latex på civilingenjörsprogrammet i Teknisk fysik. Jonathan Dartland"— Presentationens avskrift:

1

2 Rapportskrivning En introduktion till rapportskrivning och Latex på civilingenjörsprogrammet i Teknisk fysik. Jonathan Dartland Institutionen för fysik 5 april 2018

3 Mål Förstå vad en rapport ska innehålla och hur den ska se ut
Veta vad Latex är Enkelt komma igång med rapportskrivning i Latex Förstå uppbyggnaden av en Latex-mall

4 Civilingenjör och Teknisk fysiker
Vad ska en civilingenjör i teknisk fysik ha för kompetens, och vad är kompetens? Nationella mål för aktuell examen Ämnesspecifik kompetens Ingenjörsspecifik kompetens Generisk Kompetens Se utbildningsplanen för teknisk fysik  Testas genom rapportskrining, visar att ni uppfyller kraven

5 Ämnesspecifik kompetens

6 Ingenjörsspecifik kompetens

7 Generisk kompetens

8 Exempel Rapport

9 Rapportstruktur Sammanfattning/Abstract
Innehållsförteckning/Table of Contents 1 Inledning/Introduction 2 Teori/Theory 3 Metod/Experimental 4 Resultat/Results 5 Diskussion & Slutsats/Discussion & Conclusion 5.1 Felanalys/Error analysis (6 Slutsats/Conclusion) 6 Referenser A Appendix

10 Sammanfattning 100-300 ord Skrivs löpande, utan styckeindelning
Tempus: presens/imperfekt Innehålla huvuddragen av arbetet Problem, syfte, metod, resultat, analys och slutsatser Sammanfattningen är tillsammans med diskussionen de delar som det bör läggas ner mest tid på! OBS! Förkortningar, tabell-, figur- och referenshänvisningar skall ej göras I sammanfattningen. Den skall kunna läsas separat och svara på frågan “Innehåller den här rapporten det jag söker?” för någon utomstående.

11 Innehållsförteckning
Innehåller alla kapitelrubriker, helst inte mer än 3 rubriknivåer. Väldigt enkelt och skapas automatiskt i Latex.

12 Inledning Syftar till att introducera läsaren till problemområdet och intressera för vidare läsning Tempus: presens/imperfekt Glöm inte att ange referenser till påstånden >>Kort, relevant och intresseväckande stycke >>Lite historia/bakgrund till problemet >>”This laboratory was conducted in order to…” >>”The experimental setup…” >>”With the results obtained in this laboratory we would like to be able to give a reasonable explanation as to…”

13 Teori Ger läsaren en grund att stå på, hänvisas tillbaka till för att motivera de metoder/tillvägagångssätt som har valts. Tempus: Presens Numrera viktiga härledningar och ekvationer. Endast då de refereras till! Variabler och ekvationer anges i löpande text. Inga listor på variabler!! Tydliga figurer över mätuppställningar. >>”In Fig. 1 the heat cycle is shown for…” >> ”Substituting into eq. 12, we have…” Här ska alla ekvationer finnas!

14 Teori

15 Metod Tempus: Imperfekt, passiv form
Skriv noga och detaljrikt, på ett sådant sätt att experimentet blir enkelt att upprepa för en kompetent läsare. Ibland är “Teori” inbakat under Metod, men för fysikrapporter är det ofta lämpligt att ha en separat punkt för teori och hänvisa till den i metoddelen. Redogöra för varför man valt just den metod/tillvägagångssätt. Indelat i “Koncept/Concept”, “Uppsättning/Setup” och “Genomförande/Procedure”

16 Resultat Tempus: Imperfekt, passiv form
Redogör tydligt för resultat utan personliga värderingar, att resultaten är begripliga är det viktiga! Figurer och tabeller är ofta kompletterande till texten Tabeller bör finnas i appendix Dåliga mätvärden: diskutera och dra slutsatser om varför det blivit så!(under diskussion/slutsats) Ändra inte i datat!!

17 Diskussion Tempus: presens/imperfekt
Återkoppla till problemformuleringen i introduktionen Återkoppla till resultaten Felanalys >>”During the cooling of the copper heat sink the gaseous water in the air condensed on the cooled parts, effectively changing the conditions of the experiment. It is suspected that the frost build-up blocked most of the light from the LED to the sensor, as well as introducing stray currents in the system.” >>Föreslå ändringar för att reducera felen i mätningarna.

18 Slutsats Tempus: presens/imperfekt
Utifrån problemformuleringen, vad har ni slutligen kommit fram till? OBS! Diskussion/Slutsats kan ibland skrivas som en rubrik.

19 Allmänt 1: Appendix Om beräkningar eller tabeller inte är centrala för laben ska de läggas i Appendix. Appendix kan hänvisas till från den löpande texten.

20 Allmänt 2: Rätt text på rätt ställe
2. Rätt typ av text under rätt rubrik Förenkla inte förklaringar för att göra en mening finare; det är lätt att det blir syftningsfel. E.g. “Utifrån experimentellt fastställda samband redogör vi i denna rapport för…”. Om alla samband inte är experimentellt fastställda ska du låta bli att skriva en sådan mening.

21 Allmänt 3: Återkoppla till objekt
3. Figurer tabeller och numrerade ekvationer Ex. (1) ska återkopplas till i texten. Tumregel: Refererar du inte till tabellen/ figuren bör den ej vara med i rapporten!

22 Allmänt 4: Intron på huvudrubriker
4. Korta introduktioner i början av nya huvudrubriker är en god sed. Dessa är e.g. till för att väva samman stycken och ge flyt i läsningen.

23 Allmänt 5: Innehållsfokus
5. Innehållet är det viktiga, inte längden. Kan man skriva en kort rapport med samma kontenta som en lång rapport är den korta att föredra. - Med det sagt är en kort rapport inte nödvändigtvis mindre tidskrävande än en lång rapport, kanske till och med tvärt om innan man vant sig. - Ditt språk ska vara koncist = varje ord ska betyda något (motsats till ”ordbajs”)

24 Allmänt 5: Innehållsfokus
“The objective of our work is to obtain data that can be used in conjunction with a comprehensive chemical kinetics modelling study to generate a detailed understanding of the fundamental chemical processes that lead to engine knock.” (37 ord) Utan onödig text: “Our goal is to obtain experimental data that can be used with a chemical kinetics model to explain the chemical processes that lead to engine knock.” (26 ord)

25 Allmänt 6: Kritikhantering
6. Ni kommer mottaga mycket kritik, då är det viktigt att: - ni vet om att ni troligtvis inte vet hur man skriver en bra rapport i dagsläget, för att ni aldrig har gjort det förr! - inte ta kritiken personligt - se opponeringen från era klasskamrater som någonting bra, där de har tagit sig tid att hjälpa er utvecklas - ni vet att all kritik inte är berättigad

26 Allmänt 7: Opponering 7. Att vara snäll i opponeringen är det sämsta du kan göra dina kursare. Björntjänster gynnar varken opponent eller mottagare. - Med det sagt är det även viktigt att poängtera vad som gjorts bra i en rapport.

27 Allmänt 8: Rapportskrivning direkt
8. Gör första utkastet av labrapporten direkt efter labtillfället Man glömmer många detaljer otroligt snabbt! Planera för att laborationen ska ta längre tid än vad den gör!

28 Allmänt 9: Inför laborationen
9. Var helt insatt i laborationen innan labtillfället. - Läs labspec(Hemskickad i värsta fall). - Läs på om fysiken(e.g. wikipedia) - Gör de uppgifter och härledningar som finns i labspecen och inte kräver ett experiment.

29 Allmänt 10: Problem i gruppen
10. Om något inte fungerar med gruppdynamiken/gruppen ta upp det redan på första dagen med labhandledarna. Ponera att ni är i en labgrupp om fler än två personer varav en inte sköter sin förväntade uppgift enligt de krav som ställs på det examinerande momentet. Om ni då lämnar in en rapport med alla tres namn på, anses det vara fusk, och samtliga i gruppen betraktas som skyldiga.

30 Allmänt 11: Konsistent namngivning
11. Var konsistent med namngivning av objekt, subjekt och variabler i hela rapporten. Första omnämnandet: “The speed of light in a vacuum, commonly denoted c, is a universal physical constant…” - Wikipedia Vidare omnämnanden: “According to special relativity, c is the maximum speed at which all matter and information in the universe can travel.” - Wikipedia

31 Allmänt 12: Korrekturläs
12. Se till att rapporten är helt fri från - stavningsfel - syftningsfel - dåligt/inkorrekt formulerade meningar - allt som skulle få en potentiell arbetsgivare att rygga tillbak

32 Kravlista

33 Kravlista

34 Kravlista

35 Hjälpmedel Googla “TekNat UmU Rapport”, välj första resultatet, används av labhandledare etc. “Konsten att skriva en vetenskaplig Rapport” av Cecilia Emanuelsson (1999) Det är ett koncist kompendie med Många bra synpunkter. Delar av denna PP är baserade på den.

36 Vad är Latex?  Tex, typsnittsgenerator specialinriktad mot matematik skapat av Donad E. Knuth 1977 Latex, baserat på Tex.   Latex låter dig fokusera på texten och dess logiska struktur, istället för layout. Gör rapportskrivandet lite roligare

37 Editor För att arbeta med LATEX: Offline:
1. LATEX-distribution: MiKTeX(Windows), TeX Live (Linux, OSX)  2. Text editor: Atom, Sublime, Texmaker (Windows, Linux, OSX)  3. Ghostscript + GSview  - tekniskfysik.se/student/it-resurser Online: ShareLaTeX - (rekommenderas) Overleaf -

38 Exempel Följande latexkod skapar ett "Hello World!" I Latex:

39 .tex - Uppbyggnad Header - allt före \begin{document}
Dokumentet - allt mellan \begin{document} - \end{document}, det som syns Det är först när .tex-filen körs genom programmet pdfLatex (eller latex) som koden kompileras och en typsatt pdf skapas.

40 .tex - Uppbyggnad Alla .tex-filer inleds med raden:
\documentclass[alternativ]{klassnamn} där dokumentets huvudsakliga layout speciceras Kommandot \usepackage[argument]{paketnamn} används för att inkludera paket som t.ex. ändrar dokumentets språk till svenska, tillåter en att skriva matematiska symboler m.m. (definieras I Headern) Uspackage – importera färdiga  paket (klasser och metoder) 

41 Dokumentklasser Några av de vanligaste dokumentklasserna är:
article -  Vanligaste för t.ex. labbrapporter eller artiklar.  report - Längre rapporter, små böcker m.m.  book - Riktiga böcker.  beamer - Presentationer . Färdig layout

42 Ex. Mallens början De vanligaste paketen vi hittar article är: inputenc  Stöd för olika teckenkodningar, utf8 är ett vanligt argument fontec  Kopiera olika tecken i det färdiga dokumentet, använd argumentet T1 för svenska. babel  Språkalternativ, byter t.ex. Contents mot Innehåll med swedish som argument. geometry  Justeringar av t.ex. marginaler. amsmath, amssymb, . . .  Matematikrelaterade paket. fansyhdr  Sidhuvud och sidfot. hyperref  Hyperlänkar i dokumentet. Observera att dessa ofta tar extra argument inom [ ] före paketnamnet

43 Symboler Tecknen # $ % ^& _ { }~ och \ är reserverade i LATEX för speciella ändamål. Men det specika tecknet kan åstadkommas med kommandona \# \$ \% \^{} \& \_ \{ \} \~{} respektive \textbackslash{.} $ - används för ekvationer i löpande text %  - skapar en kommentar ^ och _ - skapar upphöjda respektive nedsänkta tecken ~ - skapar ett mellanslag som ej får radbrytas & - separerar kolumner i tabeller och matriser {} - separerar argument och grupperar text  # - används för argument vid egna kommandon(macros)

44 Stycken Ett stycke får skrivas på ett godtyckligt antal rader
Om man lämnar en eller era tomrader i koden påbörjas ett nytt stycke alt. \par. Nytt stycke markeras (av Latex)med indentering eller med ett utrymme mellan raderna. Kommandot \\ skapar en radbrytning utan att påbörja ett nytt stycke.

45 Ex. Stycken

46 Ex. Radbrytning

47 Ex. Komandon Alla kommandon börjar med ett backslash \, Kommandon används för allt från att ändra font, till att skapa innehållsförteckningar och matematiska symboler.

48 Miljöer En miljö inleds med \begin{} och avslutas med \end{}
Miljöer omger större mängder text och det är i dessa som t.ex. ekvationer tabeller och listor skapas, namnen på dessa är equation, table respektive itemize. Ex. Dokumentets sammanfattning I miljön abstract dvs. mellan \begin{abstract} och \end{abstract}

49 Rubriker I LATEX används kommandona \section{...} \subsection{...} \subsubsection{...} för att skapa rubriker underrubriker och under-underrubriker, där punkterna ersätts med titeln på rubriken. Dessa kommandon skapar numrerade avsnitt, vill man ha onumrerade kan en asterisk (*) läggas till i slutet av respektive kommandonanm.  Kommandot \tableofcontents skapar automatiskt en innehållsförteckning av alla numrerade avsnitt i dokumentet.

50 Listor I LATEX kan vi skapa tre typer av listor, numrerade (enumerate),punktlistor (itemize), listor med beskrivningar (description).

51 Citat I LATEX skrivs citerad text mellan  " och ". För längre citat kan miljöerna quote, quotation eller verse. quote inte indenterar, verse indenterar varje nyrad skapad med \\ och quotation indenterar första raden på varje stycke och är därför lämplig i längre citat.

52 Referenser Med kommandot \label{namn} skapas en markör till vilken vi senare kan referera till. Detta görs \ref{namn}, för ekvationer \eqref{namn}. Vanligt är t.ex. sec: för avsnitt, eq: för ekvationr och fig: för figurer. Dvs. \label{fig:figure1} quote inte indenterar, verse indenterar varje nyrad skapad med \\ och quotation indenterar första raden på varje stycke och är därför lämplig i längre citat.

53 Figurer Figurer I Latex är flytande miljöer, de läggs in där de passar bäst. Kan hoppa runt! \begin{figure}[pos] - Skapar en figur miljö.  pos – Beskriver positionering, någon följd     av htbp!. Där h placera här, t placera högst, b placera längst ner samt p placera på en fgursida. Ett ! Lättar på kraven. \centering - Centrerar positionen, kan även manipuleras med marginaler (\hspace{} \vspace{})  \caption{text} - Skapar en figurtext Pos beskriver vart den ska placeras

54 Figurer \includegraphics[argument]{filnamn} - Inkluderar
en figur i dokumentet. Som arument kan vi t.ex. ha scale=0.7 för att skala bilden till 70%. Vi kan använda bl.a. .jpg , .png och .pdf i latex om paketet grapicx är inkluderat. Glöm inte att ge figuren en label då en figur är över flödigutan minst en referens! Pos beskriver vart den ska placeras

55 Ex. Figur 1 Pos beskriver vart den ska placeras

56 Tabeller Tabeller är också en flytande miljö.
\begin{table} - Skapar tabell miljön \begin{tabular}{arg} - Skapar tabellinnehållet arg – Anger hur tabellen ska justeras t.ex. l     vänster, r höger, c centrerad, samt | vertikala linjer. & - Seprarerar kolumner \\ - Skapar ny rad \hline - Skapar en horizontell linje Observera att tebelltexten placeras över tabellen, och figurtexten under figuren Pos beskriver vart den ska placeras

57 Ex. Tabeller 1 Pos beskriver vart den ska placeras

58 Ekvationer I latex sker pressentation av ekvationer I löpande text. Detta kan göras: På samma rad mellan två $ På en egen rad med numrering \begin{equation} Observera att ekvationer är en del av en mening, ekvationer ska därför avslutas med punkt om de avslutar meningen! Pos beskriver vart den ska placeras

59 Ekvationer För ekvationer gäller generellt att varje symbol uppfattas som ett matematiskt objekt. Mellanslag inte har någon effekt och pressentation av ekvationer sker i löpande text. Detta kan göras: På samma rad mellan två $ På en egen rad med numrering \begin{equation} På egen rad utan numrering \[x+5]\ alt. \begin{equation*} Observera att ekvationer är en del av en mening, ekvationer ska därför avslutas med punkt om de avslutar meningen! Pos beskriver vart den ska placeras

60 Ex. Ekvationer(1) Pos beskriver vart den ska placeras

61 Ex. Ekvationer(2) Pos beskriver vart den ska placeras

62 Ex. Ekvationer(3) \usepackage{amsmath,amssymb,amsfonts}
Pos beskriver vart den ska placeras

63 Matematiska symboler, funktioner
Ett fåtal av alla symboler och funktioner: \^{} - Upphöjning \_{} - Nedsänkning \frac{täljare}{nämnare} - Bråk \sqrt[exponent]{värde}– Rottecken \lim_{n \to \inf} - Gränsvärde \sum_{} - Summa \int_a^b – Integral \sin - Sinus \pi – Pi symbol För fler se: Pos beskriver vart den ska placeras

64 Ex. Summer och gränsvärden
Pos beskriver vart den ska placeras

65 Ex. Integraler Pos beskriver vart den ska placeras

66 Ex. Rottecken Pos beskriver vart den ska placeras

67 Matriser Materiser kan skapas med hjälp av en matrismiljö \begin{array}{pos} – Skapar en matris pos – beskriver positionering, Om vi t.ex. skriver lcr i pos kommer första kolumnen vara vänsterjusterad, andra centrerad och tredje högerjusterad. Pos beskriver vart den ska placeras

68 Ex. Matriser (1) Pos beskriver vart den ska placeras

69 Ex. Matriser (2) Pos beskriver vart den ska placeras

70 Programkod Ibland vill man inkludera programkod i sina rapporter. För detta kan man använda sig av miljön \begin{verbatim}. Man kan även använda \begin{lstlistings} (kräver \usepackage{listings}) som har många möjligheteter. För att skriva inline-kod tex. Då man beskriver en implementerad funktion i MATLAB kan man använda \texttt{}. Pos beskriver vart den ska placeras

71 Ex. Programkod Så här kan ett enkelt C-program test.c se ut med miljön verbatim: Pos beskriver vart den ska placeras

72 Att tänka på Ekvationer tillhör texten och kan därför avsluta en mening, ett nytt stycke kan inte börja i en ekvation Figurtext under figurer, tabelltext över tabeller Se till att ni refererar till alla figurer och tabeller, annars är de överflödiga Variabler ”bor” inom $ i den löpande texten, annars ser de dåliga ut Pos beskriver vart den ska placeras

73 Vidare läsning Detta var bara ett litet smakprov. Användbara länkar angående LaTeX-skrivning och hur man skriver rapporter. The Not So Short Introduktion to LaTeX LaTeX Wikibook Länkar, guide och presentationsmaterial Pos beskriver vart den ska placeras

74 \end{föreläsning} Phust...Några frågor?
Pos beskriver vart den ska placeras

75