add legal stuff to documentation

SKIRT · Jun 11, 2014 · fdc45e1 · fdc45e1
1 parent 532ae08
commit fdc45e1
Show file tree

Hide file tree

Showing 10 changed files with 716 additions and 11 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
diff --git a/README.md b/README.md
diff --git a/README.txt b/README.txt
@@ -0,0 +1,46 @@
+PTS -- Python Toolkit for working with SKIRT
+© Astronomical Observatory, Ghent University
+
+For more information, please visit the official SKIRT home page at
+<http://www.skirt.ugent.be>.
+
+Licensing
+---------
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License version 3, as published by
+the Free Software Foundation. A copy of this license can be found in the file
+LICENSE.txt provided with the program, or at <http://www.gnu.org/licenses/>.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+Citations
+---------
+If you use (portions of) this program in your work, please cite one or more of
+the following papers.
+
+SKIRT:
+ - Baes et al. (2011, ApJS, 196, 22): Efficient Three-dimensional NLTE Dust
+   Radiative Transfer with SKIRT.
+ - Baes et al. (2003, MNRAS, 343, 1081–1094): Radiative transfer in disc
+   galaxies - The observed kinematics of dusty disc galaxies.
+ - Camps et al. (2013, A&A, 560, A35): Using 3D Voronoi grids in radiative
+   transfer simulations.
+ - Saftly et al. (2014, A&A, 561, A77): Hierarchical octree and k-d tree grids
+   for 3D radiative transfer simulations.
+ - Saftly et al. (2013, A&A, 554, A10): Using hierarchical octrees in Monte
+   Carlo radiative transfer simulations.
+
+FitSKIRT:
+ - De Geyter et al. (2013, A&A, 550, A74): FitSKIRT - genetic algorithms to
+   automatically fit dusty galaxies with a Monte Carlo radiative transfer code.
+ - De Geyter et al. (2014, MNRAS, 441, 869–885): The distribution of
+   interstellar dust in CALIFA edge-on galaxies via oligochromatic radiative
+   transfer fitting.
+
+Contact
+-------
+We invite you to freely use PTS, SKIRT and FitSKIRT under the terms described
+above. We're also open to cooperation on selected projects. Please find our
+contact information at <http://www.skirt.ugent.be>.
diff --git a/doc/0-Introduction.txt b/doc/0-Introduction.txt
@@ -12,11 +12,12 @@
 PTS consists of a set of Python modules offering functionality related to working with SKIRT, the
 Monte Carlo radiative transfer code also developed by the Astronomical Observatory at the Ghent University.
 
-This manual contains several parts:
-     - The \ref InstallationGuide describes how to install PTS on your computer.
-     - The \ref UsersGuide explains the overall philosophy behind PTS.
-     - The \ref DevelopersGuide offers guidelines on how to extend or adjust PTS.
-     - The Reference part documents every PTS class and function in detail.
+This manual is structured as follows:
+    - \ref LegalInfo.
+    - The \ref InstallationGuide describes how to install PTS on your computer.
+    - The \ref UsersGuide explains the overall philosophy behind PTS.
+    - The \ref DevelopersGuide offers guidelines on how to extend or adjust PTS.
+    - The Reference part documents every PTS class and function in detail.
 
 This manual assumes that the reader has a working knowledge of SKIRT; refer to the SKIRT manual for more information.
 

diff --git a/doc/1-LegalInfo.txt b/doc/1-LegalInfo.txt
@@ -0,0 +1,44 @@
+/**
+
+\page LegalInfo Legal Information
+
+© Astronomical Observatory, Ghent University
+
+\section LegalLic Licensing
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
+Public License version 3, as published by the Free Software Foundation. A copy of this license can be found in the file
+\c LICENSE.txt provided with the program, or at <http://www.gnu.org/licenses/>.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+details.
+
+\section LegalCit Citations
+
+If you use (portions of) this program in your work, please cite one or more of the following papers.
+
+SKIRT:
+ - <a href="http://adsabs.harvard.edu/abs/2011ApJS..196...22B">Baes et al. (2011, ApJS, 196, 22)</a>:
+   Efficient Three-dimensional NLTE Dust Radiative Transfer with SKIRT.
+ - <a href="http://adsabs.harvard.edu/abs/2003MNRAS.343.1081B">Baes et al. (2003, MNRAS, 343, 1081–1094)</a>:
+   Radiative transfer in disc galaxies - The observed kinematics of dusty disc galaxies.
+ - <a href="http://adsabs.harvard.edu/abs/2013A%26A...560A..35C">Camps et al. (2013, A&A, 560, A35)</a>:
+   Using 3D Voronoi grids in radiative transfer simulations.
+ - <a href="http://adsabs.harvard.edu/abs/2014A%26A...561A..77S">Saftly et al. (2014, A&A, 561, A77)</a>:
+   Hierarchical octree and k-d tree grids for 3D radiative transfer simulations.
+ - <a href="http://adsabs.harvard.edu/abs/2013A%26A...554A..10S">Saftly et al. (2013, A&A, 554, A10)</a>:
+   Using hierarchical octrees in Monte Carlo radiative transfer simulations.
+
+FitSKIRT:
+ - <a href="http://adsabs.harvard.edu/abs/2013A%26A...550A..74D">De Geyter et al. (2013, A&A, 550, A74)</a>:
+   FitSKIRT - genetic algorithms to automatically fit dusty galaxies with a Monte Carlo radiative transfer code.
+ - <a href="http://adsabs.harvard.edu/abs/2014MNRAS.441..869D">De Geyter et al. (2014, MNRAS, 441, 869–885)</a>:
+   The distribution of interstellar dust in CALIFA edge-on galaxies via oligochromatic radiative transfer fitting.
+
+\section LegalCon Contact
+
+We invite you to use PTS, SKIRT and FitSKIRT under the terms described above. We're also open to cooperation on
+selected projects. Please find our contact information at <a href="http://www.skirt.ugent.be">www.skirt.ugent.be</a>.
+
+*/
diff --git a/doc/1-InstallationGuide.txt → doc/2-InstallationGuide.txt b/doc/1-InstallationGuide.txt → doc/2-InstallationGuide.txt
diff --git a/doc/2-UsersGuide.txt → doc/3-UsersGuide.txt b/doc/2-UsersGuide.txt → doc/3-UsersGuide.txt
diff --git a/doc/3-DevelopersGuide.txt → doc/4-DevelopersGuide.txt b/doc/3-DevelopersGuide.txt → doc/4-DevelopersGuide.txt
diff --git a/doc/4-EagleGuide.txt → doc/5-EagleGuide.txt b/doc/4-EagleGuide.txt → doc/5-EagleGuide.txt
diff --git a/doc/html.doxygen b/doc/html.doxygen
@@ -44,7 +44,7 @@ PROJECT_NUMBER         = "Version 6"
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Python Toolkit for SKIRT"
+PROJECT_BRIEF          = "Python Toolkit for SKIRT © Astronomical Observatory, Ghent University"
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
 # the documentation. The maximum height of the logo should not exceed 55 pixels