Skip to content

Commit 016672d

Browse files
mhjensenmhjensen
committed
explicit grading
1 parent 12d67c7 commit 016672d

File tree

3 files changed

+278
-0
lines changed

3 files changed

+278
-0
lines changed

‎doc/Projects/EvaluationGrading/EvaluationForm.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
# Template for evaluating and grading projects, with grading scale based on achieved points
2+
3+
**Evaluation of project number:**
4+
5+
**Name:**
6+
7+
8+
## Abstract
9+
*Abstract: accurate and informative? Total number of possible points: 5*
10+
11+
Mark and comments:
12+
13+
14+
## Introduction
15+
*Introduction: status of problem and the major objectives. Total number of
16+
possible points: 10*
17+
18+
Mark and comments:
19+
20+
21+
## Formalism
22+
*Formalism/methods: Discussion of the methods used and their basis/suitability.
23+
Total number of possible points 20*
24+
25+
Mark and comments:
26+
27+
28+
## Code, implementation and testing
29+
*Code/Implementations/test: Readability of code, implementation, testing and
30+
discussion of benchmarks. Total number of possible points 20*
31+
32+
Mark and comments:
33+
34+
35+
## Analysis
36+
*Analysis: of results and the effectiveness of their selection and presentation.
37+
Are the results well understood and discussed? Total number of possible points:
38+
20*
39+
40+
Mark and comments:
41+
42+
43+
## Conclusions
44+
*Conclusions, discussions and critical comments: on what was learned about the
45+
method used and on the results obtained. Possible directions and future
46+
improvements? Total number of possible points: 10*
47+
48+
Mark and comments:
49+
50+
51+
## Overall presentation:
52+
*Clarity of figures, tables, algorithms and overall presentation. Too much or too little? Total number of possible points: 10*
53+
54+
Mark and comments:
55+
56+
57+
## Referencing
58+
*Referencing: relevant works cited accurately? Total number of possible points 5*
59+
60+
Mark and comments:
61+
62+
63+
## Overall
64+
*Overall mark in points (maximum number of points per project is 100) and final possible final comments*
65+
66+
67+
## Grading of all projects
68+
*The final number of points is based on the average of all projects (including eventual additional points) and the grade follows the following table:*
69+
70+
* 92-100 points: A
71+
* 77-91 points: B
72+
* 58-76 points: C
73+
* 46-57 points: D
74+
* 40-45 points: E
75+
* 0-39 points: F-failed
76+
77+
## General guidelines on how to write a report
78+
79+
### Some basic ingredients for a successful numerical project
80+
81+
When building up a numerical project there are several elements you should think of, amongst these we take the liberty of mentioning the following:
82+
83+
* How to structure a code in terms of functions
84+
* How to make a module
85+
* How to read input data flexibly from the command line
86+
* How to create graphical/web user interfaces
87+
* How to write unit tests (test functions)
88+
* How to refactor code in terms of classes (instead of functions only), in our case you think of a system and a solver class
89+
* How to conduct and automate large-scale numerical experiments
90+
* How to write scientific reports in various formats (LaTeX, HTML)
91+
92+
93+
The conventions and techniques outlined here will save you a lot of time when you incrementally extend software over time from simpler to more complicated problems. In particular, you will benefit from many good habits:
94+
95+
* New code is added in a modular fashion to a library (modules)
96+
* Programs are run through convenient user interfaces
97+
* It takes one quick command to let all your code undergo heavy testing
98+
* Tedious manual work with running programs is automated,
99+
* Your scientific investigations are reproducible, scientific reports with top quality typesetting are produced both for paper and electronic devices.
100+
101+
102+
103+
104+
### The report: how to write a good scienfitic/technical report
105+
What should it contain? A typical structure
106+
107+
* An abstract where you give the main summary of your work
108+
* 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
109+
* Theoretical models and technicalities. This is the methods section
110+
* Results and discussion
111+
* Conclusions and perspectives
112+
* Appendix with extra material
113+
* Bibliography
114+
115+
Keep always a good log of what you do.
116+
117+
### The report, the abstract
118+
119+
The abstract gives the reader a quick overview of what has been done and the most important results. Try to be to the point and state your main findings.
120+
121+
### The report, the introduction
122+
123+
When you write the introduction you could focus on the following aspects
124+
125+
* Motivate the reader, the first part of the introduction gives always a motivation and tries to give the overarching ideas
126+
* What I have done
127+
* The structure of the report, how it is organized etc
128+
129+
### The report, discussion of methods, implementation, codes etc
130+
131+
* Describe the methods and algorithms
132+
* 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
133+
* 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.
134+
135+
136+
137+
### The report, results part
138+
139+
* Present your results
140+
* Give a critical discussion of your work and place it in the correct context.
141+
* Relate your work to other calculations/studies
142+
* An eventual reader should be able to reproduce your calculations if she/he wants to do so. All input variables should be properly explained.
143+
* 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.
144+
145+
### The report, conclusions and perspectives
146+
147+
* State your main findings and interpretations
148+
* Try as far as possible to present perspectives for future work
149+
* Try to discuss the pros and cons of the methods and possible improvements
150+
151+
152+
### The report, appendices
153+
154+
* Additional calculations used to validate the codes
155+
* Selected calculations, these can be listed with few comments
156+
* Listing of the code if you feel this is necessary
157+
158+
You can consider moving parts of the material from the methods section to the appendix. You can also place additional material on your webpage or GitHub page..
159+
160+
### The report, references
161+
162+
* Give always references to material you base your work on, either scientific articles/reports or books.
163+
* Refer to articles as: name(s) of author(s), journal, volume (boldfaced), page and year in parenthesis.
164+
* Refer to books as: name(s) of author(s), title of book, publisher, place and year, eventual page numbers

‎doc/Projects/EvaluationGrading/EvaluationGrading.html‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<h1 id="template-for-evaluating-and-grading-projects-with-grading-scale-based-on-achieved-points">Template for evaluating and grading projects, with grading scale based on achieved points</h1>
2+
<p><strong>Evaluation of project number:</strong></p>
3+
<p><strong>Name:</strong></p>
4+
<h2 id="abstract">Abstract</h2>
5+
<p><em>Abstract: accurate and informative? Total number of possible points: 5</em></p>
6+
<p>Mark and comments:</p>
7+
<h2 id="introduction">Introduction</h2>
8+
<p><em>Introduction: status of problem and the major objectives. Total number of possible points: 10</em></p>
9+
<p>Mark and comments:</p>
10+
<h2 id="formalism">Formalism</h2>
11+
<p><em>Formalism/methods: Discussion of the methods used and their basis/suitability. Total number of possible points 20</em></p>
12+
<p>Mark and comments:</p>
13+
<h2 id="code-implementation-and-testing">Code, implementation and testing</h2>
14+
<p><em>Code/Implementations/test: Readability of code, implementation, testing and discussion of benchmarks. Total number of possible points 20</em></p>
15+
<p>Mark and comments:</p>
16+
<h2 id="analysis">Analysis</h2>
17+
<p><em>Analysis: of results and the effectiveness of their selection and presentation. Are the results well understood and discussed? Total number of possible points: 20</em></p>
18+
<p>Mark and comments:</p>
19+
<h2 id="conclusions">Conclusions</h2>
20+
<p><em>Conclusions, discussions and critical comments: on what was learned about the method used and on the results obtained. Possible directions and future improvements? Total number of possible points: 10</em></p>
21+
<p>Mark and comments:</p>
22+
<h2 id="overall-presentation">Overall presentation:</h2>
23+
<p><em>Clarity of figures, tables, algorithms and overall presentation. Too much or too little? Total number of possible points: 10</em></p>
24+
<p>Mark and comments:</p>
25+
<h2 id="referencing">Referencing</h2>
26+
<p><em>Referencing: relevant works cited accurately? Total number of possible points 5</em></p>
27+
<p>Mark and comments:</p>
28+
<h2 id="overall">Overall</h2>
29+
<p><em>Overall mark in points (maximum number of points per project is 100) and final possible final comments</em></p>
30+
<h2 id="grading-of-all-projects">Grading of all projects</h2>
31+
<p><em>The final number of points is based on the average of all projects (including eventual additional points) and the grade follows the following table:</em></p>
32+
<ul>
33+
<li>92-100 points: A</li>
34+
<li>77-91 points: B</li>
35+
<li>58-76 points: C</li>
36+
<li>46-57 points: D</li>
37+
<li>40-45 points: E</li>
38+
<li>0-39 points: F-failed</li>
39+
</ul>
40+
<h2 id="general-guidelines-on-how-to-write-a-report">General guidelines on how to write a report</h2>
41+
<h3 id="some-basic-ingredients-for-a-successful-numerical-project">Some basic ingredients for a successful numerical project</h3>
42+
<p>When building up a numerical project there are several elements you should think of, amongst these we take the liberty of mentioning the following:</p>
43+
<ul>
44+
<li>How to structure a code in terms of functions</li>
45+
<li>How to make a module</li>
46+
<li>How to read input data flexibly from the command line</li>
47+
<li>How to create graphical/web user interfaces</li>
48+
<li>How to write unit tests (test functions)</li>
49+
<li>How to refactor code in terms of classes (instead of functions only), in our case you think of a system and a solver class</li>
50+
<li>How to conduct and automate large-scale numerical experiments</li>
51+
<li>How to write scientific reports in various formats (LaTeX, HTML)</li>
52+
</ul>
53+
<p>The conventions and techniques outlined here will save you a lot of time when you incrementally extend software over time from simpler to more complicated problems. In particular, you will benefit from many good habits:</p>
54+
<ul>
55+
<li>New code is added in a modular fashion to a library (modules)</li>
56+
<li>Programs are run through convenient user interfaces</li>
57+
<li>It takes one quick command to let all your code undergo heavy testing</li>
58+
<li>Tedious manual work with running programs is automated,</li>
59+
<li>Your scientific investigations are reproducible, scientific reports with top quality typesetting are produced both for paper and electronic devices.</li>
60+
</ul>
61+
<h3 id="the-report-how-to-write-a-good-scienfitictechnical-report">The report: how to write a good scienfitic/technical report</h3>
62+
<p>What should it contain? A typical structure</p>
63+
<ul>
64+
<li>An abstract where you give the main summary of your work</li>
65+
<li>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</li>
66+
<li>Theoretical models and technicalities. This is the methods section</li>
67+
<li>Results and discussion</li>
68+
<li>Conclusions and perspectives</li>
69+
<li>Appendix with extra material</li>
70+
<li>Bibliography</li>
71+
</ul>
72+
<p>Keep always a good log of what you do.</p>
73+
<h3 id="the-report-the-abstract">The report, the abstract</h3>
74+
<p>The abstract gives the reader a quick overview of what has been done and the most important results. Try to be to the point and state your main findings.</p>
75+
<h3 id="the-report-the-introduction">The report, the introduction</h3>
76+
<p>When you write the introduction you could focus on the following aspects</p>
77+
<ul>
78+
<li>Motivate the reader, the first part of the introduction gives always a motivation and tries to give the overarching ideas</li>
79+
<li>What I have done</li>
80+
<li>The structure of the report, how it is organized etc</li>
81+
</ul>
82+
<h3 id="the-report-discussion-of-methods-implementation-codes-etc">The report, discussion of methods, implementation, codes etc</h3>
83+
<ul>
84+
<li>Describe the methods and algorithms</li>
85+
<li>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</li>
86+
<li>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.</li>
87+
</ul>
88+
<h3 id="the-report-results-part">The report, results part</h3>
89+
<ul>
90+
<li>Present your results</li>
91+
<li>Give a critical discussion of your work and place it in the correct context.</li>
92+
<li>Relate your work to other calculations/studies</li>
93+
<li>An eventual reader should be able to reproduce your calculations if she/he wants to do so. All input variables should be properly explained.</li>
94+
<li>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.</li>
95+
</ul>
96+
<h3 id="the-report-conclusions-and-perspectives">The report, conclusions and perspectives</h3>
97+
<ul>
98+
<li>State your main findings and interpretations</li>
99+
<li>Try as far as possible to present perspectives for future work</li>
100+
<li>Try to discuss the pros and cons of the methods and possible improvements</li>
101+
</ul>
102+
<h3 id="the-report-appendices">The report, appendices</h3>
103+
<ul>
104+
<li>Additional calculations used to validate the codes</li>
105+
<li>Selected calculations, these can be listed with few comments</li>
106+
<li>Listing of the code if you feel this is necessary</li>
107+
</ul>
108+
<p>You can consider moving parts of the material from the methods section to the appendix. You can also place additional material on your webpage or GitHub page..</p>
109+
<h3 id="the-report-references">The report, references</h3>
110+
<ul>
111+
<li>Give always references to material you base your work on, either scientific articles/reports or books.</li>
112+
<li>Refer to articles as: name(s) of author(s), journal, volume (boldfaced), page and year in parenthesis.</li>
113+
<li>Refer to books as: name(s) of author(s), title of book, publisher, place and year, eventual page numbers</li>
114+
</ul>

‎doc/Projects/EvaluationGrading/EvaluationGrading.pdf‎

114 KB
Binary file not shown.

0 commit comments

Comments
 (0)