Update documentation

anderkve · Sep 9, 2024 · 130b10b · 130b10b
1 parent 0797eae
commit 130b10b
Show file tree

Hide file tree

Showing 73 changed files with 1,103 additions and 125 deletions.
diff --git a/README.html b/README.html
@@ -346,6 +346,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="book/writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="book/writing_reports/checklist.html">
    Checklist for reports

diff --git a/_sources/book/projects/project1.md b/_sources/book/projects/project1.md
@@ -7,6 +7,7 @@
 
 - **Format:**
   - A pdf document, typeset in LaTeX, with answers to all the problems below. You deliver the pdf on Canvas.
+  - Use the template we have provided [here](./../writing_reports/project_templates.md).
   - Code (with comments, of course) on a UiO GitHub repo ([github.uio.no](https://github.uio.no/)), with the URL to you repo written in the pdf document.
   - You *must* deliver via your group on Canvas (even if you are working alone).
 

diff --git a/_sources/book/projects/project2.md b/_sources/book/projects/project2.md
@@ -10,6 +10,7 @@
 
 - **Format:** 
   - A pdf document, typeset in LaTeX, with answers to all the problems below. You deliver the pdf on Canvas.
+  - Use the template we have provided [here](./../writing_reports/project_templates.md).
   - Code (with comments, of course) on a UiO GitHub repo ([github.uio.no](https://github.uio.no/)), with the URL to you repo written in the pdf document. 
   - You *must* deliver via your group on Canvas (even if you are working alone).
 

diff --git a/_sources/book/projects/project3.md b/_sources/book/projects/project3.md
@@ -9,7 +9,8 @@ Not published yet.
 
 - **Deadline**: Wednesday, October 23, 23:59.
 - **Format:**
-  - A scientific report, typeset in LaTeX *using the provided template*, delivered as a pdf file on Canvas.
+  - A scientific report, typeset in LaTeX, delivered as a pdf file on Canvas.
+  - Use the report template we have provided [here](./../writing_reports/project_templates.md).
   - Code (with comments, of course) on a UiO GitHub repo ([github.uio.no](https://github.uio.no/)), with the URL to you repo written in the pdf document. 
   - You *must* deliver via your group on Canvas (even if you are working alone).
 

diff --git a/_sources/book/projects/project4.md b/_sources/book/projects/project4.md
@@ -13,7 +13,8 @@ While working on the project, check this page regularly in case of small updates
 
 - **Deadline**: Wednesday, November 20, 23:59.
 - **Format:**
-  - A scientific report, typeset in LaTeX *using the provided template* (see [this page](../writing_reports/introduction_to_latex.md)), delivered as a pdf file on Canvas.
+  - A scientific report, typeset in LaTeX, delivered as a pdf file on Canvas.
+  - Use the report template we have provided [here](./../writing_reports/project_templates.md).
   - Code (with comments, of course) on a UiO GitHub repo ([github.uio.no](https://github.uio.no/)), with the URL to you repo written in the pdf document. 
   - You *must* deliver via your group on Canvas (even if you are working alone).
 

diff --git a/_sources/book/projects/project5.md b/_sources/book/projects/project5.md
@@ -13,7 +13,8 @@ There will probably be small updates to the project description in the coming da
 
 - **Deadline**: Wednesday, December 11, 23:59.
 - **Format:**
-  - A scientific report, typeset in LaTeX *using the provided template* (see [this page](../writing_reports/introduction_to_latex.md)), delivered as a pdf file on Canvas.
+  - A scientific report, typeset in LaTeX, delivered as a pdf file on Canvas.
+  - Use the report template we have provided [here](./../writing_reports/project_templates.md).
   - Code (with comments, of course) on a UiO GitHub repo ([github.uio.no](https://github.uio.no/)), with the URL to you repo written in the pdf document. 
   - You *must* deliver via your group on Canvas (even if you are working alone).
 

diff --git a/_sources/book/writing_reports/introduction_to_latex.md b/_sources/book/writing_reports/introduction_to_latex.md
@@ -26,43 +26,6 @@ Since this course typically involves collaborating with others on a single docum
 However, you can of course also just use your git repository to collaborate on a `.tex` file, like you would for any code file. Use whatever solution works best for you and your collaborators.
 
 
-## Templates
-
-### Template for projects 1 and 2: problem sets
-
-We've prepared a template for you to use in the two first projects. We have both the source code found in a `.tex` and a rendered file in `.pdf` format.
-
-- The [tex file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/oppgave_mal.tex)
-- The [pdf file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/oppgave_mal.pdf)
-
-The above `.tex` example tries to include a figure file `rel_err.pdf` from a subdirectory `imgs`. If you want to compile this example yourself, you can get the figure file [here](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/imgs/rel_err.pdf).
-
-
-### Template for projects 3, 4 and 5: scientific reports
-
-Here's a template you can use when writing the scientific reports for projects 3, 4 and 5. We recommend taking the time to read through all the text in the template, as it contains a lot of useful information on how to structure a scientific report, as well as some LaTeX tips and tricks.
-
-- The [tex file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/report_example.tex)
-- The [pdf file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/report_example.pdf)
-- The [BibTex references file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/ref.bib)
-
-To easily view the template "in action", you can access it as a read-only Overleaf project [here](https://www.overleaf.com/read/ykjsqvchkhyz).
-
-If you want to compile the template report yourself, you'll need a figure file `rel_err.pdf` in a subdirectory `imgs`. (Just like for the template for projects 1 and 2.) You can get the figure file [here](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/imgs/rel_err.pdf).
-
-To build the template along with the reference list, you need to run `pdflatex` and `bibtex` a few times over. Here's a single-line command that should do the trick:
-
-```sh
-pdflatex report_example.tex && bibtex report_example.aux && pdflatex report_example.tex && pdflatex report_example.tex
-```
-
-
-### Example report
-
-An example of a very good student report from a few years back can be found [here](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/example_report.pdf).
-
-
-
 ## LaTeX resources
 
 Here are some LaTeX resources that might come in handy:

diff --git a/_sources/book/writing_reports/project_templates.md b/_sources/book/writing_reports/project_templates.md
@@ -0,0 +1,34 @@
+# Project templates
+
+## Template for projects 1 and 2: problem sets
+
+We have prepared a template for you to use in the two first projects. Below you find both the `.tex` file and the corresponding generated `.pdf` file.
+
+- The [tex file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/oppgave_mal.tex)
+- The [pdf file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/oppgave_mal.pdf)
+
+The above `.tex` example tries to include a figure file `rel_err.pdf` from a subdirectory `imgs`. If you want to compile this example yourself, you can get the figure file [here](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/imgs/rel_err.pdf).
+
+
+## Template for projects 3, 4 and 5: scientific reports
+
+Below is the template you should use when writing the scientific reports for projects 3, 4 and 5. We recommend taking the time to read through all the text in the template, as it contains a lot of useful information on how to structure a scientific report, as well as some LaTeX tips and tricks.
+
+- The [tex file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/report_example.tex)
+- The [pdf file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/report_example.pdf)
+- The [BibTex references file](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/ref.bib)
+
+To easily view the template "in action", you can access it as a read-only Overleaf project [here](https://www.overleaf.com/read/ykjsqvchkhyz).
+
+If you want to compile the template report yourself, you'll need a figure file `rel_err.pdf` in a subdirectory `imgs`. (Just like for the template for projects 1 and 2.) You can get the figure file [here](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/tex_mal/imgs/rel_err.pdf).
+
+To build the template along with the reference list, you need to run `pdflatex` and `bibtex` a few times over. Here's a single-line command that should do the trick:
+
+```sh
+pdflatex report_example.tex && bibtex report_example.aux && pdflatex report_example.tex && pdflatex report_example.tex
+```
+
+
+### Example report
+
+An example of a very good student report from a few years back can be found [here](https://github.com/anderkve/FYS3150/blob/master/book/writing_reports/example_report.pdf).
diff --git a/book/getting_ready/linux_users.html b/book/getting_ready/linux_users.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/getting_ready/mac_users.html b/book/getting_ready/mac_users.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/getting_ready/windows_users.html b/book/getting_ready/windows_users.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/classes.html b/book/introduction_to_cpp/classes.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/code_structure.html b/book/introduction_to_cpp/code_structure.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/common_errors.html b/book/introduction_to_cpp/common_errors.html
@@ -346,6 +346,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/compiling_and_linking_take_1.html b/book/introduction_to_cpp/compiling_and_linking_take_1.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/compiling_and_linking_take_2.html b/book/introduction_to_cpp/compiling_and_linking_take_2.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/containers.html b/book/introduction_to_cpp/containers.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/debugging.html b/book/introduction_to_cpp/debugging.html
@@ -346,6 +346,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/declaration_vs_definition.html b/book/introduction_to_cpp/declaration_vs_definition.html
@@ -346,6 +346,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/functions_take_1.html b/book/introduction_to_cpp/functions_take_1.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/functions_take_2.html b/book/introduction_to_cpp/functions_take_2.html
@@ -346,6 +346,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/hello_world.html b/book/introduction_to_cpp/hello_world.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/if_else.html b/book/introduction_to_cpp/if_else.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/input_and_output.html b/book/introduction_to_cpp/input_and_output.html
@@ -346,6 +346,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/intro.html b/book/introduction_to_cpp/intro.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/intro_to_armadillo.html b/book/introduction_to_cpp/intro_to_armadillo.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/loops.html b/book/introduction_to_cpp/loops.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/online_resources.html b/book/introduction_to_cpp/online_resources.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports

diff --git a/book/introduction_to_cpp/pointers.html b/book/introduction_to_cpp/pointers.html
@@ -348,6 +348,11 @@ <h1 class="site-logo" id="site-title">FYS3150/FYS4150 course material</h1>
    Introduction to LaTeX
   </a>
  </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../writing_reports/project_templates.html">
+   Project templates
+  </a>
+ </li>
  <li class="toctree-l1">
   <a class="reference internal" href="../writing_reports/checklist.html">
    Checklist for reports