1 | |
---|
2 | MCNET GUIDELINES |
---|
3 | |
---|
4 | for Event Generator Authors and Users |
---|
5 | |
---|
6 | |
---|
7 | PREAMBLE |
---|
8 | |
---|
9 | This generator has been developed as part of an academic research |
---|
10 | project and is the result of many years of work by the authors. |
---|
11 | Proper academic recognition is a requirement for its continued |
---|
12 | development. |
---|
13 | |
---|
14 | The components of the program have been developed to work together |
---|
15 | as a coherent physics framework. We believe that the creation of |
---|
16 | separately maintained forks or piecewise distribution of individual |
---|
17 | parts would diminish their scientific value. |
---|
18 | |
---|
19 | The authors are convinced that software development in a scientific |
---|
20 | context requires full availability of all source code, to further |
---|
21 | progress and to allow local modifications to meet the specific |
---|
22 | requirements of the individual user. |
---|
23 | |
---|
24 | Therefore we have decided to release this program under the |
---|
25 | GNU General Public License (GPL) version 2. This ensures |
---|
26 | that the source code will be available to you and grants you the |
---|
27 | freedom to use and modify the program. You can redistribute your |
---|
28 | modified versions as long as you retain the GPL and respect existing |
---|
29 | copyright notices (see the file 'COPYING' for details). |
---|
30 | |
---|
31 | By using the GPL, we entrust you with considerable freedom and expect |
---|
32 | you to use it wisely, since the GPL does not address the issues in |
---|
33 | the first two paragraphs. To remedy this shortcoming, we have |
---|
34 | formulated the following guidelines relevant for the distribution |
---|
35 | and usage of event generator software in an academic setting. |
---|
36 | |
---|
37 | |
---|
38 | GUIDELINES |
---|
39 | |
---|
40 | 1) The integrity of the program should be respected. |
---|
41 | ------------------------------------------------- |
---|
42 | |
---|
43 | 1.1) Suspected bugs and proposed fixes should be reported back to the |
---|
44 | original authors to be considered for inclusion in the standard |
---|
45 | distribution. No independently developed and maintained forks |
---|
46 | should be created as long as the original authors actively work on |
---|
47 | the program. |
---|
48 | |
---|
49 | 1.2) The program should normally be redistributed in its entirety. |
---|
50 | When there are special reasons, an agreement should be sought with |
---|
51 | the original authors to redistribute only specific parts. This |
---|
52 | should be arranged such that the redistributed parts remain |
---|
53 | updated in step with the standard distribution. |
---|
54 | |
---|
55 | 1.3) Any changes in the code must be clearly marked in the source |
---|
56 | (reason, author, date) and documented. If any modified version is |
---|
57 | redistributed it should be stated at the point of distribution |
---|
58 | (download link) that it has been modified and why. |
---|
59 | |
---|
60 | 1.4) If a significant part of the code is used by another program, |
---|
61 | this should be clearly specified in that program's documentation and |
---|
62 | stated at its point of distribution. |
---|
63 | |
---|
64 | 1.5) Copyright information and references may not be removed. |
---|
65 | Copyright-related program messages may not be altered and must be |
---|
66 | printed even if only a part of the program is used. Adding further |
---|
67 | messages specifying any modifications is encouraged. |
---|
68 | |
---|
69 | |
---|
70 | 2) The program and its physics should be properly cited when used for |
---|
71 | academic publications |
---|
72 | ------------------------------------------------------------------ |
---|
73 | |
---|
74 | 2.1) The main software reference as designated by the program authors |
---|
75 | should always be cited. |
---|
76 | |
---|
77 | 2.2) In addition, the original literature on which the program is based |
---|
78 | should be cited to the extent that it is of relevance for a study, |
---|
79 | applying the same threshold criteria as for other literature. |
---|
80 | |
---|
81 | 2.3) When several programs are combined, they should all be mentioned, |
---|
82 | commensurate with their importance for the physics study at hand. |
---|
83 | |
---|
84 | 2.4) To make published results reproducible, the exact versions of the |
---|
85 | codes that were used and any relevant program and parameter |
---|
86 | modifications should be spelled out. |
---|
87 | |
---|
88 | |
---|
89 | POSTSCRIPT |
---|
90 | |
---|
91 | The copyright license of the software is the GPL v2 alone, therefore |
---|
92 | the above guidelines are not legally binding. However, we reserve the |
---|
93 | right to criticize offenders. The guidelines should always be combined |
---|
94 | with common sense, for interpretation and for issues not covered. |
---|
95 | Enquiries regarding the guidelines and related issues are encouraged |
---|
96 | and should be directed to the authors of the program. |
---|
97 | |
---|
98 | Please note that the program, including all its code and documentation, |
---|
99 | is intended for academic use and is delivered "as is" to be used at |
---|
100 | your own risk, without any guarantees. |
---|
101 | |
---|
102 | ---------------------------------------------------------------------- |
---|
103 | |
---|
104 | These guidelines were edited by Nils Lavesson and David Grellscheid |
---|
105 | for the MCnet collaboration, which has approved and agreed to respect |
---|
106 | them. MCnet is a Marie Curie Research Training Network funded under |
---|
107 | Framework Programme 6 contract MRTN-CT-2006-035606. |
---|
108 | |
---|