Skip to content

Commit f35b14c

Browse files
tychontychon
committed
add GPL license
1 parent d593767 commit f35b14c

16 files changed

+765
-10
lines changed

‎COPYING

+674
Large diffs are not rendered by default.

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
test:
3-
python -m unittest discover --start-directory tests tests
3+
python -m unittest discover --start-directory tests
44

55
docupdate:
66
rm -r docs/source/maskastrometry.*

‎README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
# maskastrometry
3+
4+
Package for analyzing geometric distortions of optical systems.
5+
6+
To build the documentation get Sphinx and run
7+
8+
$ make docupdate
9+
$ make docbuild
10+
11+
Then open `./docs/build/html/index.html`.
12+
13+
There are a few unit tests for the package, though not nearly
14+
extensive. Run with
15+
16+
$ python -m unittest discover --start-directory tests
17+
18+
or
19+
20+
$ make test
21+
22+
23+
## License
24+
25+
Copyright 2018 Hannes Riechert <[email protected]>
26+
at Max-Planck-Institute for Astronomy, Heidelberg.
27+
Licensed under GPL-3.0-or-later.
28+
You can find the full text of the license in COPYING.
29+
30+
If you plan to publish the obtained results, please contact the
31+
authors for permission and latest bug fixes:
32+
33+
> Hannes Riechert <[email protected]> or <[email protected]>
34+
> Jörg-Uwe Pott <[email protected]>

‎docs/Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
7-
SPHINXPROJ = maskastrometry
7+
SPHINXPROJ = mascado
88
SOURCEDIR = source
99
BUILDDIR = build
1010

@@ -17,4 +17,4 @@ help:
1717
# Catch-all target: route all unknown targets to Sphinx using the new
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
20-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
# -- Project information -----------------------------------------------------
2222

23-
project = 'maskastrometry'
23+
project = 'MASCADO'
2424
copyright = '2018, Hannes Riechert'
2525
author = 'Hannes Riechert'
2626

‎docs/source/index.rst

+18-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
.. maskastrometry documentation master file, created by
2-
sphinx-quickstart on Thu Mar 1 18:15:38 2018.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
51

6-
Welcome to maskastrometry's documentation!
7-
==========================================
2+
Welcome to the MASCADO project documentation!
3+
=============================================
4+
5+
The delicious inspection tool for Mask AStrometry for MICADO.
86

97
.. toctree::
108
:maxdepth: 4
@@ -15,6 +13,20 @@ Welcome to maskastrometry's documentation!
1513
maskastrometry.utility
1614

1715

16+
License
17+
=======
18+
19+
| Copyright 2018 Hannes Riechert [email protected] at Max-Planck-Institute for Astronomy, Heidelberg.
20+
| Licensed under GPL-3.0-or-later. You can find the full text of the license in COPYING.
21+
22+
This software is meant for quick-look inspection of distortion data
23+
sets. If you plan to publish the obtained results, please contact the
24+
authors for permission and latest bug fixes:
25+
26+
| Hannes Riechert: [email protected], [email protected]
27+
| Jörg-Uwe Pott: [email protected]
28+
29+
1830
Indices and tables
1931
==================
2032

‎maskastrometry/distortions/polyfit.py

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
25
"""Functions for least-squares fits of polynomial vector fields.
36
47
Interface follows functional paradigm.

‎maskastrometry/distortions/polynomials.py

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
25
"""2D polynomials and vector fields.
36
47
Interface follows object oriented paradigm.

‎maskastrometry/utility/affine.py

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
25
"""Provide 2D affine transformations.
36
47
Interface follows a functional paradigm. Runs on plain NumPy arrays

‎maskastrometry/utility/plotting.py

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
25
"""Provide some plotting functions useful for distortion solutions."""
36

47

‎maskastrometry/utility/zemax.py

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
25
"""Helpers for Zemax files."""
36

47

‎scripts/analyze_grid.py

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
#!/usr/bin/python3
22

3+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
4+
# Licensed under GPL-3.0-or-later. See COPYING for details.
5+
6+
37
import argparse
48
import numpy as np
59
import matplotlib.pyplot as plt

‎scripts/compare_grids.py

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
#!/usr/bin/python3
22

3+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
4+
# Licensed under GPL-3.0-or-later. See COPYING for details.
5+
6+
37
import sys
48
import argparse
59
import numpy as np

‎tests/test_polyfit.py

+4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
5+
26
from unittest import TestCase
37

48
import numpy as np

‎tests/test_polynomials.py

+4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
5+
26
from unittest import TestCase
37

48
import numpy as np

‎tests/test_utilities.py

+4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11

2+
# Copyright 2018 Hannes Riechert at Max-Planck-Institute for Astronomy.
3+
# Licensed under GPL-3.0-or-later. See COPYING for details.
4+
5+
26
from unittest import TestCase
37

48
import numpy as np

0 commit comments

Comments
 (0)