Welcome to ProDiMo

Welcome to the official ProDiMo wiki pages.

If you are a new to ProDiMo, a good place to start is the official ProDiMo homepage, where you can find some brief code description, some recorded introductory talks and a list of relevant code papers.

If you are planning to use ProDiMo, please also read the Disclaimer below. In case if you do not have access to our GitLab repository, please contact one of the ProDiMo developers.

On this wiki you find (hopefully) all necessary information on how to install, run and use ProDiMo for your science project.

Getting Started

The Getting Started section covers the installation and compilation of ProDiMo and its requirements. Furthermore, you can find some information on tools to interpret and visualize the results.

User Guide

The User Guide starts with a guide on how to run ProDiMo, and provides a detailed description of all the features and options available in ProDiMo. Please let use know if you miss something.

Developer Guide

The Developer Guide describes how you can contribute changes to the code and documentation and some general git and coding guidelines. Before you start please contact somebody from the ProDiMo team.

Recently updated documentation

Changelog

For the latest code changes please check the changelog or the GitLab repository.

Disclaimer

This code is available on a collaborative basis, meaning ...

  • You are not permitted to pass (any parts of) the code to anyone else. If another person is interested to join, please tell him/her to follow the same procedure as you have done.
  • You have to give at least one of the developers of ProDiMo, currently Peter Woitke, Inga Kamp, Wing-Fai Thi and Christian Rab co-author rights. You should contact at least one of us in the paper preparation stage to ensure proper usage of the code in the valid parameter regime and to help set up ProDiMo models correctly. This person should be offered co-author rights and receive a complete paper draft at least 3 weeks prior to submission.
  • If you make significant contributions to ProDiMo, you can become one of the ProDiMo developers and be listed above, in order to get co-author rights on all papers that use these changes in the future.
  • In order to claim his/her co-author right on a paper going to be submitted, he/she needs to send his/her scientific comments on the paper on timescales of two weeks. Otherwise, he/she loses that right for this paper.
  • If you use ProDiMo for proposals, you don't need to ask us for permission or co-I-ship, but we would appreciate it if you would involve us in an early stage, and you are expected to send us a copy of the submitted proposal.

Remember that, as you can read this wiki page, you have signed up for these conditions.

Please also cite the specific papers when a particular option of ProDiMo is used. When particular input data (input spectrum, collision rate, chemical rates, ...) are used, please also cite the data-papers as required by the authors of those papers in addition to the database description papers.