Add GPLv2 license

README.md

@@ -1,14 +1,19 @@
 Gaia DR2 for celestia.Sci
 =========================
 
-This repository contains Python scripts to generate a celestia.Sci star
-database from the *Gaia* Data Release 2 data, supplemented by the XHIP
+This repository contains Python scripts to generate a celestia.Sci/Celestia
+star database from the *Gaia* Data Release 2 data, supplemented by the XHIP
 catalogue.
 
 In order to limit the download size required and to maintain compatibility
 with the use of HIP/TYC2 identifiers as the primary key for stars in
 celestia.Sci, only Gaia data for HIP and TYC2 stars is processed.
 
+Unless you are editing the code, it is recommended to use the pre-built files
+in the release rather than running these scripts manually. The data files in
+the release may be used under a CC-BY-SA 4.0 license
+(https://creativecommons.org/licenses/by-sa/4.0/legalcode)
+
 ## Prerequisites
 
 -  Internet connection for downloading the data
@@ -20,6 +25,7 @@ celestia.Sci, only Gaia data for HIP and TYC2 stars is processed.
 ## Folder contents
 
 -  `download_data.py`: script to download the data files
+-  `make_stardb.py`: script to build the star database and cross-index files
 
 ## How to use
 
@@ -49,6 +55,9 @@ celestia.Sci, only Gaia data for HIP and TYC2 stars is processed.
 8.  The stars.dat, hdxindex.dat and saoxindex.dat files will be written into
     the output folder
 
+9.  Copy the files into the `data` folder of the celestia.Sci/Celestia
+    distribution.
+
 ## Source catalogues
 
 - Gaia Data Release 2 (https://gea.esac.esa.int/archive/)

download_data.py

@@ -1,5 +1,22 @@
 #!/usr/bin/env python3
 
+# gaia-stardb: Processing Gaia DR2 for celestia.Sci/Celestia
+# Copyright (C) 2019  Andrew Tribick
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 """Routines for downloading the data files."""
 
 import contextlib

make_stardb.py

@@ -1,5 +1,22 @@
 #!/usr/bin/env python3
 
+# gaia-stardb: Processing Gaia DR2 for celestia.Sci/Celestia
+# Copyright (C) 2019  Andrew Tribick
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 """Makes the star database."""
 
 import contextlib

parse_hip.py

@@ -1,3 +1,20 @@
+# gaia-stardb: Processing Gaia DR2 for celestia.Sci/Celestia
+# Copyright (C) 2019  Andrew Tribick
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 """Routines for parsing the HIP data."""
 
 import gzip

parse_tyc.py

@@ -1,3 +1,20 @@
+# gaia-stardb: Processing Gaia DR2 for celestia.Sci/Celestia
+# Copyright (C) 2019  Andrew Tribick
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 """Routines for parsing the TYC2 data."""
 
 import gzip

spparse.py

@@ -1,3 +1,20 @@
+# gaia-stardb: Processing Gaia DR2 for celestia.Sci/Celestia
+# Copyright (C) 2019  Andrew Tribick
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 """Routines for parsing spectral types."""
 
 import re