Solver stability enhancements and package restructuring

.gitignore

@@ -1,16 +1,59 @@
-*.pyc
-*.egg-info
-__pycache__/
-relic/
-RELIC-INFO
+# Compiled files
+*.py[cod]
+*.a
+*.o
+*.so
+__pycache__
 
 # Other generated files
 */version.py
-docs/_build
+*/cython_version.py
+htmlcov
+.coverage
+MANIFEST
+.ipynb_checkpoints
+
+# Sphinx
+docs/api
+docs/_build/
 
 # WingIDE
 *.wpr
 *.wpu
 
+# Eclipse editor project files
+.project
+.pydevproject
+.settings
+
+# Pycharm editor project files
+.idea
+
+# Packages/installer info
+*.egg
+*.egg-info
+dist/
+build/
+eggs
+.eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+distribute-*.tar.gz
+relic/
+RELIC-INFO
+
+# codecov
+.coverage
+*.coverage.*
+
+# Other
+*~
+.settings
+devdata/
+
 # Mac OSX
-.DS_Store
+.DS_Store

CHANGELOG.rst

@@ -1,9 +1,31 @@
-=========
-CHANGELOG
-=========
+.. _release_notes:
 
-v0.1.2 (12-June-2017)
-=====================
+=============
+Release Notes
+=============
+
+.. 0.2.1 (unreleased)
+   ==================
+
+
+0.2.0 (unreleased)
+==================
+
+Added
+^^^^^
+
+- Added a new, more stable, solver ``rlu_solve()``. ``match_lsq()`` now takes
+  a new parameter ``solver`` which, by default, is set to ``'LU'`` - the
+  new solver. [#1]
+
+Fixed
+^^^^^
+
+- Updated package structure, setup, docs. [#1]
+
+
+0.1.2 (12-June-2017)
+====================
 
 Added
 ^^^^^
@@ -27,8 +49,8 @@ Added
     New parameter ``ext_return`` indicates to return extended information.
 
 
-v0.1.1 (06-June-2017)
-=====================
+0.1.1 (06-June-2017)
+====================
 
 Added
 ^^^^^
@@ -46,7 +68,7 @@ Fixed
   for generating coordinate arrays.
 
 
-v0.1.0 (09-May-2017)
-====================
+0.1.0 (09-May-2017)
+===================
 
 Initial release.

CODE_OF_CONDUCT.md

@@ -0,0 +1,24 @@
+# Spacetelescope Open Source Code of Conduct
+
+We expect all "spacetelescope" organization projects to adopt a code of conduct that ensures a productive, respectful environment for all open source contributors and participants. We are committed to providing a strong and enforced code of conduct and expect everyone in our community to follow these guidelines when interacting with others in all forums. Our goal is to keep ours a positive, inclusive, successful, and growing community. The community of participants in open source Astronomy projects is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences success and continued growth. 
+
+
+As members of the community,
+
+- We pledge to treat all people with respect and provide a harassment- and bullying-free environment, regardless of sex, sexual orientation and/or gender identity, disability, physical appearance, body size, race, nationality, ethnicity, and religion. In particular, sexual language and imagery, sexist, racist, or otherwise exclusionary jokes are not appropriate.
+
+- We pledge to respect the work of others by recognizing acknowledgment/citation requests of original authors. As authors, we pledge to be explicit about how we want our own work to be cited or acknowledged.
+
+- We pledge to welcome those interested in joining the community, and realize that including people with a variety of opinions and backgrounds will only serve to enrich our community. In particular, discussions relating to pros/cons of various technologies, programming languages, and so on are welcome, but these should be done with respect, taking proactive measure to ensure that all participants are heard and feel confident that they can freely express their opinions.
+
+- We pledge to welcome questions and answer them respectfully, paying particular attention to those new to the community. We pledge to provide respectful criticisms and feedback in forums, especially in discussion threads resulting from code contributions.
+
+- We pledge to be conscientious of the perceptions of the wider community and to respond to criticism respectfully. We will strive to model behaviors that encourage productive debate and disagreement, both within our community and where we are criticized. We will treat those outside our community with the same respect as people within our community.
+
+- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting [email protected] (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
+
+This code of conduct applies to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
+
+Parts of this code of conduct have been adapted from the Astropy and Numfocus codes of conduct.
+http://www.astropy.org/code_of_conduct.html
+https://www.numfocus.org/about/code-of-conduct/

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (C) 2017, Mihai Cara & Association of Universities for Research in Astronomy
+Copyright (C) 2019, Association of Universities for Research in Astronomy
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

docs/.rtd-environment.yml

@@ -0,0 +1,14 @@
+name: wiimatch
+channels:
+    - defaults
+dependencies:
+    - "python>=3.5"
+    - setuptools
+    - numpy
+    - numpydoc
+    - graphviz
+    - pip:
+      - "sphinx<=1.8.5"
+      - sphinx_rtd_theme
+      - stsci_rtd_theme
+      - sphinx_automodapi

docs/Makefile

@@ -10,7 +10,7 @@ BUILDDIR      = _build
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
 
@@ -19,7 +19,6 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
 #This is needed with git because git doesn't create a dir if it's empty
 $(shell [ -d "_static" ] || mkdir -p _static)
 
-
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html       to make standalone HTML files"
@@ -81,17 +80,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/packagename.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/wiimatch.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/packagename.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/wiimatch.qhc"
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/packagename"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/packagename"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/wiimatch"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/wiimatch"
 	@echo "# devhelp"
 
 epub:

docs/make.bat

@@ -6,7 +6,7 @@ if "%SPHINXBUILD%" == "" (
         set SPHINXBUILD=sphinx-build
 )
 set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
 if NOT "%PAPER%" == "" (
         set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 )

docs/source/CHANGELOG.rst

@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst

docs/source/LICENSE.rst

@@ -0,0 +1,5 @@
+*******
+LICENSE
+*******
+
+.. include:: ../../LICENSE.txt