Downloading and Installation¶
Prerequisites¶
The lmfit package requires Python, Numpy, and Scipy. Scipy version 0.13 or higher is recommended, but extensive testing on compatibility with various versions of scipy has not been done. Lmfit works with Python 2.7, 3.3 and 3.4. No testing has been done with Python 3.5, but as the package is pure Python, relying only on scipy and numpy, no significant troubles are expected. The nose framework is required for running the test suite, and IPython and matplotib are recommended. If Pandas is available, it will be used in portions of lmfit.
Installation¶
If you have pip installed, you can install lmfit with:
pip install lmfit
or, if you have Python Setup Tools installed, you install lmfit with:
easy_install -U lmfit
or, you can download the source kit, unpack it and install with:
python setup.py install
Development Version¶
To get the latest development version, use:
git clone http://github.com/lmfit/lmfit-py.git
and install using:
python setup.py install
Testing¶
A battery of tests scripts that can be run with the nose testing
framework is distributed with lmfit in the tests folder. These are
routinely run on the development version. Running nosetests should run
all of these tests to completion without errors or failures.
Many of the examples in this documentation are distributed with lmfit in
the examples folder, and should also run for you. Many of these require
Acknowledgements¶
Many people have contributed to lmfit.
Matthew Newville wrote the original version and maintains the project.
Till Stensitzki wrote the improved estimates of confidence intervals, and
contributed many tests, bug fixes, and documentation.
Daniel B. Allan wrote much of the high level Model code, and many
improvements to the testing and documentation.
Antonino Ingargiola wrote much of the high level Model code and provided
many bug fixes.
J. J. Helmus wrote the MINUT bounds for leastsq, originally in
leastsqbounds.py, and ported to lmfit.
E. O. Le Bigot wrote the uncertainties package, a version of which is used
by lmfit.
Michal Rawlik added plotting capabilities for Models.
A. R. J. Nelson added differential_evolution, and greatly improved the code
in the docstrings.
Additional patches, bug fixes, and suggestions have come from Christoph
Deil, Francois Boulogne, Thomas Caswell, Colin Brosseau, nmearl,
Gustavo Pasquevich, Clemens Prescher, LiCode, and Ben Gamari.
The lmfit code obviously depends on, and owes a very large debt to the code
in scipy.optimize. Several discussions on the scipy-user and lmfit mailing
lists have also led to improvements in this code.
License¶
The LMFIT-py code is distribution under the following license:
Copyright, Licensing, and Re-distribution
-----------------------------------------
The LMFIT-py code is distribution under the following license:
Copyright (c) 2014 Matthew Newville, The University of Chicago
Till Stensitzki, Freie Universitat Berlin
Daniel B. Allen, Johns Hopkins University
Michal Rawlik, Eidgenossische Technische Hochschule, Zurich
Antonino Ingargiola, University of California, Los Angeles
A. R. J. Nelson, Australian Nuclear Science and Technology Organisation
Permission to use and redistribute the source code or binary forms of this
software and its documentation, with or without modification is hereby
granted provided that the above notice of copyright, these terms of use,
and the disclaimer of warranty below appear in the source code and
documentation, and that none of the names of above institutions or
authors appear in advertising or endorsement of works derived from this
software without specific prior written permission from all parties.
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 THIS SOFTWARE.