rename package from maskastrometry to mascado

tychon · tychon · commit 9516a359b9a8 · 2018-03-09T00:47:52.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,4 @@
 .cache/
 __pycache__/
 docs/build/
-docs/source/maskastrometry*
+docs/source/mascado*
diff --git a/Makefile b/Makefile
@@ -3,9 +3,9 @@ test:
 	python -m unittest discover --start-directory tests
 
 docupdate:
-	rm -r docs/source/maskastrometry.*
+	rm -rf docs/source/mascado.*
 	cd docs; \
-	sphinx-apidoc -MeT -o source/ ../maskastrometry
+	sphinx-apidoc -MeT -o source/ ../mascado
 
 docbuild:
 	cd docs; \
diff --git a/README.md b/README.md
@@ -1,9 +1,11 @@
 
-# maskastrometry
+# MASCADO
 
-Package for analyzing geometric distortions of optical systems.
+Package for analyzing geometric distortions of optical systems.  This
+software is meant for quick-look inspection of distortion data sets.
 
-To build the documentation get Sphinx and run
+The documentation is available at https://tychons.net/mascado/  
+If you want to build it yourself, get Sphinx and run
 
     $ make docupdate
     $ make docbuild
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -108,7 +108,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'maskastrometrydoc'
+htmlhelp_basename = 'mascadodoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -135,7 +135,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'maskastrometry.tex', 'maskastrometry Documentation',
+    (master_doc, 'mascado.tex', 'MASCADO Documentation',
      'Hannes Riechert', 'manual'),
 ]
 
@@ -145,7 +145,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'maskastrometry', 'maskastrometry Documentation',
+    (master_doc, 'mascado', 'MASCADO Documentation',
      [author], 1)
 ]
 
@@ -156,8 +156,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'maskastrometry', 'maskastrometry Documentation',
-     author, 'maskastrometry', 'One line description of project.',
+    (master_doc, 'mascado', 'MASCADO Documentation',
+     author, 'mascado', 'One line description of project.',
      'Miscellaneous'),
 ]
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,13 +4,15 @@ Welcome to the MASCADO project documentation!
 
 The delicious inspection tool for Mask AStrometry for MICADO.
 
+Project is on Github at `<https://github.com/tychon/mascado>`_.
+
 .. toctree::
    :maxdepth: 4
    :caption: Contents:
 
    scripts
-   maskastrometry.distortions
-   maskastrometry.utility
+   mascado.distortions
+   mascado.utility
 
 
 License
diff --git a/docs/source/scripts.rst b/docs/source/scripts.rst
@@ -3,9 +3,9 @@ User Scripts
 ============
 
 In the ``./scripts`` directory of the repository you can find several
-scripts for various tasks.  Since they are using the
-``maskastrometry`` module, you have to make that available in your
-python path, or run the scripts from the repository root using::
+scripts for various tasks.  Since they are using the ``mascado``
+module, you have to make that available in your python path, or run
+the scripts from the repository root using::
 
   $ python3 -m scripts.SCRIPTNAME ARGS...
 
diff --git a/mascado/__init__.py b/mascado/__init__.py
diff --git a/mascado/distortions/__init__.py b/mascado/distortions/__init__.py
diff --git a/mascado/distortions/polyfit.py b/mascado/distortions/polyfit.py
@@ -14,7 +14,7 @@
 Examples
 --------
 
->>> from maskastrometry.distortions.polynomials import (
+>>> from mascado.distortions.polynomials import (
 ...     PolyVectorField, Legendre)
 >>> vf = PolyVectorField(Legendre(3))
 >>> grid = np.array([[0, 0], [1, 1], [0, 1], [1, 0], [0.5, 0.5]])
@@ -43,7 +43,7 @@ def polyfit_svd(vf, positions, vectors, sigmas=None,
 
     Parameters
     ----------
-    vf : :class:`maskastrometry.distortions.polynomials.PolyVectorField`
+    vf : :class:`mascado.distortions.polynomials.PolyVectorField`
         Model of vector field providing the Vandermonde matrix.
     positions : (N,2)-shaped array
         x,y positions of data points.
@@ -206,7 +206,7 @@ def polyfit_svd_iterative(vf, positions, vectors, sigmas, maxoutliers,
 
     Parameters
     ----------
-    vf : :class:`maskastrometry.distortions.polynomials.PolyVectorField`
+    vf : :class:`mascado.distortions.polynomials.PolyVectorField`
         2D vector field.  Internal parameters are neither used nor changed.
     positions : (N, 2)-shaped array
     vectors : (N, 2)-shaped array
diff --git a/mascado/distortions/polynomials.py b/mascado/distortions/polynomials.py
diff --git a/mascado/utility/__init__.py b/mascado/utility/__init__.py
diff --git a/mascado/utility/affine.py b/mascado/utility/affine.py
diff --git a/mascado/utility/plotting.py b/mascado/utility/plotting.py
@@ -11,8 +11,8 @@
 from matplotlib.gridspec import GridSpec
 from matplotlib.ticker import MaxNLocator
 
-from maskastrometry.distortions.polynomials import PolyVectorField, Legendre
-from maskastrometry.distortions.polyfit import polyfit_svd
+from mascado.distortions.polynomials import PolyVectorField, Legendre
+from mascado.distortions.polyfit import polyfit_svd
 
 
 def set_fontsize(small=8, medium=10, bigger=12):
diff --git a/mascado/utility/zemax.py b/mascado/utility/zemax.py
diff --git a/scripts/analyze_grid.py b/scripts/analyze_grid.py
@@ -8,9 +8,9 @@
 import numpy as np
 import matplotlib.pyplot as plt
 
-import maskastrometry.utility.affine as affine
-import maskastrometry.utility.zemax as zemax
-import maskastrometry.utility.plotting as plotting
+import mascado.utility.affine as affine
+import mascado.utility.zemax as zemax
+import mascado.utility.plotting as plotting
 
 
 def main():
diff --git a/scripts/compare_grids.py b/scripts/compare_grids.py
@@ -9,9 +9,9 @@
 import numpy as np
 import matplotlib.pyplot as plt
 
-import maskastrometry.utility.affine as affine
-import maskastrometry.utility.zemax as zemax
-import maskastrometry.utility.plotting as plotting
+import mascado.utility.affine as affine
+import mascado.utility.zemax as zemax
+import mascado.utility.plotting as plotting
 
 
 def main():
diff --git a/tests/test_polyfit.py b/tests/test_polyfit.py
@@ -6,8 +6,8 @@
 from unittest import TestCase
 
 import numpy as np
-from maskastrometry.distortions.polynomials import PolyVectorField, Legendre
-from maskastrometry.distortions.polyfit import (
+from mascado.distortions.polynomials import PolyVectorField, Legendre
+from mascado.distortions.polyfit import (
     polyfit_svd, polyfit_svd_iterative)
 
 
diff --git a/tests/test_polynomials.py b/tests/test_polynomials.py
@@ -7,7 +7,7 @@
 
 import numpy as np
 
-from maskastrometry.distortions.polynomials import (
+from mascado.distortions.polynomials import (
     Cartesian, Legendre, Chebyshev, Zernike,
     PolyVectorField)
 
diff --git a/tests/test_utilities.py b/tests/test_utilities.py
@@ -8,7 +8,7 @@
 import numpy as np
 import pandas as pd
 
-from maskastrometry.utility import affine
+from mascado.utility import affine
 
 
 class AffineTestCase (TestCase):
