|
| 1 | +{ |
| 2 | + "cells": [ |
| 3 | + { |
| 4 | + "cell_type": "markdown", |
| 5 | + "id": "d87403fc", |
| 6 | + "metadata": {}, |
| 7 | + "source": [ |
| 8 | + "<!-- HTML file automatically generated from DocOnce source (https://github.com/doconce/doconce/)\n", |
| 9 | + "doconce format html projectwriting.do.txt -->\n", |
| 10 | + "<!-- dom:TITLE: How to write a scientific project -->" |
| 11 | + ] |
| 12 | + }, |
| 13 | + { |
| 14 | + "cell_type": "markdown", |
| 15 | + "id": "e88d6de0", |
| 16 | + "metadata": {}, |
| 17 | + "source": [ |
| 18 | + "# How to write a scientific project\n", |
| 19 | + "**Morten Hjorth-Jensen**, Department of Physics, University of Oslo and Department of Physics and Astronomy and National Superconducting Cyclotron Laboratory, Michigan State University\n", |
| 20 | + "\n", |
| 21 | + "Date: **Sep 26, 2023**\n", |
| 22 | + "\n", |
| 23 | + "Copyright 1999-2023, Morten Hjorth-Jensen. Released under CC Attribution-NonCommercial 4.0 license" |
| 24 | + ] |
| 25 | + }, |
| 26 | + { |
| 27 | + "cell_type": "markdown", |
| 28 | + "id": "2b6137a3", |
| 29 | + "metadata": {}, |
| 30 | + "source": [ |
| 31 | + "## The report: how to write a good scienfitic/technical report\n", |
| 32 | + "**What should it contain? A typical structure.**\n", |
| 33 | + "\n", |
| 34 | + " * An abstract where you give the main summary of your work\n", |
| 35 | + "\n", |
| 36 | + " * An introduction where you explain the aims and rationale for the physics case and what you have done. At the end of the introduction you should give a brief summary of the structure of the report\n", |
| 37 | + "\n", |
| 38 | + " * Theoretical models and technicalities. This is the methods section\n", |
| 39 | + "\n", |
| 40 | + " * Code structure, tests and more\n", |
| 41 | + "\n", |
| 42 | + " * Results and discussion\n", |
| 43 | + "\n", |
| 44 | + " * Conclusions and perspectives\n", |
| 45 | + "\n", |
| 46 | + " * Appendix with extra material\n", |
| 47 | + "\n", |
| 48 | + " * Bibliography\n", |
| 49 | + "\n", |
| 50 | + "Keep always a good log of what you do." |
| 51 | + ] |
| 52 | + }, |
| 53 | + { |
| 54 | + "cell_type": "markdown", |
| 55 | + "id": "7b782bf5", |
| 56 | + "metadata": {}, |
| 57 | + "source": [ |
| 58 | + "## The report, the abstract\n", |
| 59 | + "The abstract gives the reader a quick overview of what has been done and the most important results. Here is a typical example\n", |
| 60 | + "taken from a recent [scientific article](https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.131.131401) \n", |
| 61 | + "\n", |
| 62 | + "**We construct the first four-dimensional multiple black hole solution of general relativity with a positive cosmological constant. The solution consists of two static black holes whose gravitational attraction is balanced by the cosmic expansion. These static binaries provide the first four-dimensional example of nonuniqueness in general relativity without matter.**\n", |
| 63 | + "\n", |
| 64 | + "If you have specific recommendations and/or results you may also highlight them in the abstract." |
| 65 | + ] |
| 66 | + }, |
| 67 | + { |
| 68 | + "cell_type": "markdown", |
| 69 | + "id": "64115d65", |
| 70 | + "metadata": {}, |
| 71 | + "source": [ |
| 72 | + "## The report, the introduction\n", |
| 73 | + "**What should I focus on? Introduction.**\n", |
| 74 | + "\n", |
| 75 | + "You don't need to answer all questions in a chronological order. When you write the introduction you could focus on the following aspects\n", |
| 76 | + " * Motivate the reader, the first part of the introduction gives always a motivation and tries to give the overarching ideas\n", |
| 77 | + "\n", |
| 78 | + " * What I have done\n", |
| 79 | + "\n", |
| 80 | + " * The structure of the report, how it is organized etc" |
| 81 | + ] |
| 82 | + }, |
| 83 | + { |
| 84 | + "cell_type": "markdown", |
| 85 | + "id": "f5d92d4d", |
| 86 | + "metadata": {}, |
| 87 | + "source": [ |
| 88 | + "## The report, discussion of methods and codes\n", |
| 89 | + "**What should I focus on? Methods sections.**\n", |
| 90 | + "\n", |
| 91 | + " * Describe the methods and algorithms\n", |
| 92 | + "\n", |
| 93 | + " * You need to explain how you implemented the methods and also say something about the structure of your algorithm and present some parts of your code\n", |
| 94 | + "\n", |
| 95 | + " * You should plug in some calculations to demonstrate your code, such as selected runs used to validate and verify your results. The latter is extremely important!! A reader needs to understand that your code reproduces selected benchmarks and reproduces previous results, either numerical and/or well-known closed form expressions.\n", |
| 96 | + "\n", |
| 97 | + "See also the next slide." |
| 98 | + ] |
| 99 | + }, |
| 100 | + { |
| 101 | + "cell_type": "markdown", |
| 102 | + "id": "3c40a7db", |
| 103 | + "metadata": {}, |
| 104 | + "source": [ |
| 105 | + "## The report, code part\n", |
| 106 | + "\n", |
| 107 | + "Try to make a GitHub/Gitlab etc repository with three folders\n", |
| 108 | + "\n", |
| 109 | + "1. One which contains the report\n", |
| 110 | + "\n", |
| 111 | + "2. One which contains some test runs and eventually additional results not presented in the report\n", |
| 112 | + "\n", |
| 113 | + "3. One which contains the code\n", |
| 114 | + "\n", |
| 115 | + "The code should be well documented and make sure it produces the results you are showing in the report. Here you can doucment soruce files and/or jupyter-notebooks.\n", |
| 116 | + "\n", |
| 117 | + "You may also add a README file which tells what is contained in the this repository." |
| 118 | + ] |
| 119 | + }, |
| 120 | + { |
| 121 | + "cell_type": "markdown", |
| 122 | + "id": "827a5d78", |
| 123 | + "metadata": {}, |
| 124 | + "source": [ |
| 125 | + "## The report, results part\n", |
| 126 | + "**What should I focus on? Results.**\n", |
| 127 | + "\n", |
| 128 | + " * Present your results\n", |
| 129 | + "\n", |
| 130 | + " * Give a critical discussion of your work and place it in the correct context.\n", |
| 131 | + "\n", |
| 132 | + " * Relate your work to other calculations/studies\n", |
| 133 | + "\n", |
| 134 | + " * An eventual reader should be able to reproduce your calculations. All input variables should be properly explained.\n", |
| 135 | + "\n", |
| 136 | + " * Make sure that figures and tables should contain enough information in their captions, axis labels etc so that an eventual reader can gain a first impression of your work by studying figures and tables only." |
| 137 | + ] |
| 138 | + }, |
| 139 | + { |
| 140 | + "cell_type": "markdown", |
| 141 | + "id": "af36654a", |
| 142 | + "metadata": {}, |
| 143 | + "source": [ |
| 144 | + "## The report, conclusions and perspectives\n", |
| 145 | + "**What should I focus on? Conclusions.**\n", |
| 146 | + "\n", |
| 147 | + " * State your main findings and interpretations\n", |
| 148 | + "\n", |
| 149 | + " * Try as far as possible to present perspectives for future work\n", |
| 150 | + "\n", |
| 151 | + " * Try to discuss the pros and cons of the methods and possible improvements" |
| 152 | + ] |
| 153 | + }, |
| 154 | + { |
| 155 | + "cell_type": "markdown", |
| 156 | + "id": "4e1110c4", |
| 157 | + "metadata": {}, |
| 158 | + "source": [ |
| 159 | + "## The report, appendices\n", |
| 160 | + "**What should I focus on? additional material.**\n", |
| 161 | + "\n", |
| 162 | + " * Additional calculations used to validate the codes\n", |
| 163 | + "\n", |
| 164 | + " * Selected calculations, these can be listed with few comments\n", |
| 165 | + "\n", |
| 166 | + " * Listing of the code if you feel this is necessary\n", |
| 167 | + "\n", |
| 168 | + "You can consider moving parts of the material from the methods section to the appendix or your GitHub/Gitlab repository. You can also place additional material on your webpage." |
| 169 | + ] |
| 170 | + }, |
| 171 | + { |
| 172 | + "cell_type": "markdown", |
| 173 | + "id": "3e43a925", |
| 174 | + "metadata": {}, |
| 175 | + "source": [ |
| 176 | + "## The report, references\n", |
| 177 | + "**What should I focus on? References.**\n", |
| 178 | + "\n", |
| 179 | + " * Give always references to material you base your work on, either scientific articles/reports or books.\n", |
| 180 | + "\n", |
| 181 | + " * Refer to articles as: name(s) of author(s), journal, volume (boldfaced), page and year in parenthesis.\n", |
| 182 | + "\n", |
| 183 | + " * Refer to books as: name(s) of author(s), title of book, publisher, place and year, eventual page numbers" |
| 184 | + ] |
| 185 | + }, |
| 186 | + { |
| 187 | + "cell_type": "markdown", |
| 188 | + "id": "40bd5668", |
| 189 | + "metadata": {}, |
| 190 | + "source": [ |
| 191 | + "## Where do I find scientific articles, books etc and examples of reports\n", |
| 192 | + " * With a UiO IP number you can access freely all books and scientific journals available at our [University library](http://www.ub.uio.no/)\n", |
| 193 | + "\n", |
| 194 | + " * For scientific articles, go to for example the journal [Physical Review Letters of the American Physical Society](http://journals.aps.org/prl/issues/117/10)" |
| 195 | + ] |
| 196 | + }, |
| 197 | + { |
| 198 | + "cell_type": "markdown", |
| 199 | + "id": "3421124c", |
| 200 | + "metadata": {}, |
| 201 | + "source": [ |
| 202 | + "## Procrastination... the curse of all?\n", |
| 203 | + "<!-- dom:FIGURE: [fig-projectwriting/procrast.jpg, width=700 frac=0.9] -->\n", |
| 204 | + "<!-- begin figure -->\n", |
| 205 | + "\n", |
| 206 | + "<img src=\"fig-projectwriting/procrast.jpg\" width=\"700\"><p style=\"font-size: 0.9em\"><i>Figure 1: </i></p>\n", |
| 207 | + "<!-- end figure -->\n", |
| 208 | + "\n", |
| 209 | + "[Enjoy this video](https://www.youtube.com/watch?v=arj7oStGLkU)\n", |
| 210 | + "\n", |
| 211 | + "[And research shows that procrastinating enhances creativity!!](http://www.nytimes.com/2016/01/17/opinion/sunday/why-i-taught-myself-to-procrastinate.html?_r=0)" |
| 212 | + ] |
| 213 | + } |
| 214 | + ], |
| 215 | + "metadata": { |
| 216 | + "kernelspec": { |
| 217 | + "display_name": "Python 3 (ipykernel)", |
| 218 | + "language": "python", |
| 219 | + "name": "python3" |
| 220 | + }, |
| 221 | + "language_info": { |
| 222 | + "codemirror_mode": { |
| 223 | + "name": "ipython", |
| 224 | + "version": 3 |
| 225 | + }, |
| 226 | + "file_extension": ".py", |
| 227 | + "mimetype": "text/x-python", |
| 228 | + "name": "python", |
| 229 | + "nbconvert_exporter": "python", |
| 230 | + "pygments_lexer": "ipython3", |
| 231 | + "version": "3.9.10" |
| 232 | + } |
| 233 | + }, |
| 234 | + "nbformat": 4, |
| 235 | + "nbformat_minor": 5 |
| 236 | +} |
0 commit comments