After GEOframe is becoming widely used we believe it is time to set some fair rules for participation to GEOframe related publications, Since the components are usually released under
GPL3 license, it allows the of the code almost without any restriction (except the maintaining the derived code Open Source and freely available), a condition mitigated by the fact that different OMS components can be released under other licenses. However, because all of our recognition derives from publications (and proper citations), it is worth to remark what written below:
GEOframe Community Publication Policy (GCPP v1.0)
- Introduction
GEOframe-NewAge is an open-source, semi-distributed, component-based hydrological modeling system. It was developed in Java and based on the environmental modeling framework Object Modeling System V3 (OMS3).
The core of the project was born from the idea of Professor Rigon and mainly developed at the department of civil, environmental and mechanical engineering of University of Trento, Italy. During the last decade, GEOframe community grew and now is made of many scientists around the world who share their work, codes, knowledge and experiences for the benefit of all GEOframe users, whilst pursuing their individual research interests and careers.
Therefore, giving appropriate credits for the intellectual input through co-authorships or citations should be the proper functioning of the community.
This document sets out how members of the GEOframe community should recognise the intellectual contribution of the GEOframe community’s members.
- Principal web references
In the following, the principal GEOframe web references, where you can find the latest achievements, developments, publications, code versions, courses and ideas are reported:
- General principles
The formal, legal conditions that govern the use of GEOframe at present are given by the G.P.L. v 3. Each GEOframe component can have its own license though.
This Policy applies to all uses of GEOframe products, including but not limited to data and computer code, for research and teaching. It is not intended to restrict what can be done with them, rather to ensure appropriate acknowledgement and communication between users and developers. This policy will be updated regularly.
A developer is any person whose expertise has either significantly influenced the design of GEOframe code or who has written code, with no distinction between scientific and technical inputs.
Developers are encouraged to publish their work in reasonable time, while potential users should approach developers early in their study to avoid duplication or wasted effort on new developments. Developers may reserve the right for the first scientific application of their scheme and will be able to advise if and when co-authorship, citation or acknowledgement is appropriate.
A list of new developments and the scientists responsible for them will be maintained on the GEOframe website. These contributions should be recognised by citations.
When writing the source code of a component, GEOframe developers should consider the following:
- Provide a brief description of what the program does.
- State the authors of the code and the following modifiers.
- Describe the input required to run the component and its output.
- Some notes concerning the limitations, and the algorithms used within the component. A wish-list for the future version and/or information.
- Articles or books which have inspired the codex or justified its necessity. Users are encouraged to cite these papers in their own work.
- A more detailed documentation about the code can be found in (link alla pagina con la documentazione delle componenti e il template per LaTeX.
- If you want to contribute code or documentation, create pull requests, we will consider them.
- Avoid practices of code-washing.
Ideally a committed code should conform to the rules required by Joss.
Acknowledgments should be considered for a wider list of scientists who contributed to the modelling system, but whose contributions may not be documented in publications. A list of such scientists will be maintained on the GEOframe web page
When writing a paper, GEOframe users and developers should consider the following:
Co-authorship
- Is expected if your published research benefited from a new development, i.e. the development influenced your study to the extent that it was discussed in the paper.
- In order to favor early publication of new components (or new algorithms), when a paper fundamentally relies on a code which contains a new, unpublished algorithm, the inclusion of the author's algorithm should be considered. ***
- Is expected if your research required substantial direct input from a developer, e.g. to make substantial modifications to the code that you used, to help design the experiments etc.
- Should be considered for a wider list of scientists who contributed to the modelling system, but whose contributions may not be documented in publications. A list of such scientists will be maintained on the GEOframe web page.
Acknowledgements
- Should be considered for scientists involved in GEOframe code developments that have become established.
Citation of a published paper
- Is expected if a citable paper describing a development exists. A narrative description of the model and a list of papers describing developments will be maintained on the GEOframe web page.
Please be generous in offering credit for other people’s work, as everyone benefits in the end. Use best judgement and, if in doubt, err on the side of inclusiveness.
*** In order to facilitate the recognition of new contributions that deserve considering co-authorship, we establish the following. Untagged components should be considered not usable/unstable/unsafe/new. Tagged components should be the only one to be used freely but if their tag number ends with "9" this means that the co-authorship has to be discussed. Other tag numbers let you use the component without any problem. So version 1.0 can be used freely. For version 0.09 co-autorship should be discussed (even if the low number suggests some caution). In any case these limitation perdure for at most 1 year. Therefore a 15.0009 version could be used freely after 1 year of embargo in any case.
For the readers can also be interesting to consider the reading of
About Authorship in Hydrology.
