DOC: Updated License, Readme and changelog

License Updated to MIT license from BSD 3-Clause. These are compatible licenses, so nothing substantive has changed. Resolves #52

Readme has been updated to reflect more recent changes to code base.

Changelog updated to include latest bugfixes and license change.

Minor cleaning of gitignore.

[skip ci]

.gitignore

@@ -32,8 +32,3 @@ venv*/*
 # Quick Tests #
 ###############
 main.py
-scan0010.dat
-scan0012.dat
-scan013.ng5
-scan0018.dat
-test_volume*

LICENSE.txt

@@ -1,28 +1,19 @@
-Copyright (c) 2014-2016 David M. Fobes, http://pseudocubic.com
+Copyright (c) 2014-2016 David M. Fobes
 
-All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-  a. Redistributions of source code must retain the above copyright notice,
-     this list of conditions and the following disclaimer.
-  b. Redistributions in binary form must reproduce the above copyright
-     notice, this list of conditions and the following disclaimer in the
-     documentation and/or other materials provided with the distribution.
-  c. Neither the name of SymPy nor the names of its contributors
-     may be used to endorse or promote products derived from this software
-     without specific prior written permission.
-
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -5,36 +5,41 @@ NeutronPy
 
     v0.x.0 releases may not be backwards compatibile. This software is in a fluid state and undergoing rapid changes. The v1.0.0 release will indicate the start of backwards compatibile updates. Major number releases (x.0) may break backwards compatibility, but users will be notified in the changelog.
 
-**master** |master| :: **develop** |develop|
+**master** |master| :: **develop** |develop| :: **coverage** |coverage|
 
 .. |master| image:: https://travis-ci.org/neutronpy/neutronpy.svg?branch=master
       :target: https://travis-ci.org/neutronpy/neutronpy
 
 .. |develop| image:: https://travis-ci.org/neutronpy/neutronpy.svg?branch=develop
       :target: https://travis-ci.org/neutronpy/neutronpy
 
+.. |coverage| image:: https://codecov.io/github/neutronpy/neutronpy/coverage.svg?branch=develop
+      :target: https://codecov.io/github/neutronpy/neutronpy?branch=develop
+
 NeutronPy is a python library with commonly used tools for neutron scattering measurements, primarily for Triple Axis Spectrometer data, but easily applied to other types of data, including Time of Flight.
 
 * Triple Axis Spectrometer resolution function calculation (Translated from ResLib), including:
 	* Resolution ellipses
-	* Instrument visualization (planned)
+	* Instrument visualization
 * Form factor calculation, including:
 	* Structure factors with support for
 		* Mass Normalization
 		* Debye-Waller factor
-		* Unit cell visualization (future)
+		* Unit cell visualization
 	* Single-ion magnetic form factor calculation
 * Least-Squares fitting (KMPFIT, based on the C-implementation of MPFIT, from the Kapteyn package)
 * Basic data operations
    * Binning
    * Monitor Normalization
    * Calculated peak integrated intensity, position, and width
-   * Loading from known filetypes (SPICE, ICE, and ICP supported. More planned)
-   * Plotting (incomplete)
-   * Slicing (future)
+   * Loading from known filetypes
+   * Plotting
+   * Slicing
 * And More...
 
-NeutronPy is developed by David M Fobes in the `Neutron Scattering Group <http://neutrons.phy.bnl.gov/>`_, part of the Condensed Matter Physics & Materials Science Department (CMPMSD) at `Brookhaven National Laboratory <http://www.bnl.gov/>`_, a `US Department of Energy, Office of Basic Energy Sciences <http://science.energy.gov/bes/>`_ funded laboratory.
+See `Roadmap <https://github.com/neutronpy/neutronpy/wiki/Roadmap>`_ for future features
+
+NeutronPy was originally developed by David M Fobes in the `Neutron Scattering Group <http://neutrons.phy.bnl.gov/>`_, part of the Condensed Matter Physics & Materials Science Department (CMPMSD) at `Brookhaven National Laboratory <http://www.bnl.gov/>`_. It is currently being developed in the `MPA-CMMS <http://www.lanl.gov/org/padste/adeps/materials-physics-applications/condensed-matter-magnet-science/index.php>`_ department of `Los Alamos National Laboratory <http://www.lanl.gov/>`_. Both are `US Department of Energy, Office of Basic Energy Sciences <http://science.energy.gov/bes/>`_ funded laboratories.
 
 NeutronPy is a work-in-progress (see the roadmap in the wiki for indications of new upcoming features) and as such, still has many bugs, so use at your own risk. See the Disclaimer below. To report bugs or suggest features see the Contributions section below.
 
@@ -46,8 +51,9 @@ The following packages are required to install this library:
 * ``numpy >= 1.8.0``
 * ``scipy >= 0.13.0``
 * ``Cython >= 0.20``
-* ``matplotlib >= 1.3.0``
+* ``matplotlib >= 1.3.0`` (optional, plotting)
 * ``nose >= 1.3.0`` (optional, tests)
+* ``h5py`` (optional, file IO)
 
 Installation
 ------------
@@ -65,12 +71,18 @@ Contributions may be made by submitting a pull-request for review using the fork
 
 Copyright & Licensing
 ---------------------
-Copyright (c) 2014-2015, David M. Fobes, Released under terms in LICENSE.
+Copyright (c) 2014-2016, David M. Fobes, Released under terms in LICENSE.
 
 KMPFIT and MPFIT are currently used in part from the `Kapteyn <https://www.astro.rug.nl/software/kapteyn/>`_ package and a custom implementation of the `MINPACK-1 <http://www.physics.wisc.edu/~craigm/idl/cmpfit.html>`_ Least Squares Fitting Library in C, released under the terms in LICENSE.KAPTEYN and LICENSE.MPFIT, respectively.
 
 The source for the Triple Axis Spectrometer resolution calculations was translated in part from the `ResLib <http://www.neutron.ethz.ch/research/resources/reslib>`_ 3.4c (2009) library released under the terms in LICENSE.RESLIB, originally developed by Andrey Zheludev at Brookhaven National Laboratory, Oak Ridge National Laboratory and ETH Zuerich. email: zhelud@ethz.ch.
 
 Disclaimer
 ----------
-THE SOFTWARE IS SUPPLIED "AS IS" WITHOUT WARRANTY OF ANY KIND. THE COPYRIGHT HOLDERS, THEIR THIRD PARTY LICENSORS, THE UNITED STATES, THE UNITED STATES DEPARTMENT OF ENERGY, AND THEIR EMPLOYEES: (1) DISCLAIM ANY WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT, (2) DO NOT ASSUME ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF THE SOFTWARE, (3) DO NOT REPRESENT THAT USE OF THE SOFTWARE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS, (4) DO NOT WARRANT THAT THE SOFTWARE WILL FUNCTION UNINTERRUPTED, THAT IT IS ERROR-FREE OR THAT ANY ERRORS WILL BE CORRECTED.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

doc/changelog.rst

@@ -2,6 +2,12 @@
 Changelog
 =========
 
+* :support:`52` Updated License from BSD 3-Clause to MIT License
+* :bug:`51` Fixed default behavior of :py:attr:`.Instrument.moncor` variable in :py:class:`.Instrument` to coincide with documentation
+* :bug:`50` Explicitly defined vertical mosaic ``vmosaic`` in :py:class:`.Sample`
+* :bug:`49` Fixed incorrect usage of ``strftime`` in :py:meth:`.Instrument.plot_projections`
+* :bug:`48` Fixed error when ``u`` and ``v`` were defined at ``list`` types instead of ``ndarray`` in :py:class:`.Sample`
+
 * :release:`v0.3.4 <2016-01-21>` 40, 41, 42, 43, 44, 45, 46, 47
 * :support:`40` Added unittests for all libraries to increase code coverage
 * :support:`41` Added documentation for spurion library, corrected docs for resolution and core libraries