/GOFit

Global Optimization for Fitting Problems

Primary LanguageC++BSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

License Build Status PyPI Version

GOFit: Global Optimization for Fitting problems

GOFit is a package of C++ algorithms with python interfaces designed for the global optimization of parameters in curve fitting, i.e. for nonlinear least-squares problems arising from curve fitting. GOFit was developed with scientific curve fitting problems in mind but is also applicable to general curve fitting problems provided they can be formulated as nonlinear least-squares problems.

Full details on how to use GOFit are available in the documentation.

Requirements

GOFit provides pre-built Python wheels for most common platforms with all dependencies included. However if a wheel does not exist for your platform (or if building from source), GOFit requires the following software to be installed:

Installing GOFit

For easy installation, use pip:

$ pip install gofit

Note that if an older install of GOFit is present on your system you can use:

$ pip install --upgrade gofit

to upgrade GOFit to the latest version.

Installing GOFit from source

Alternatively, you can download the source code from Github and unpack as follows:

$ git clone https://github.com/ralna/gofit
$ cd gofit

GOFit can then be compiled and installed using:

$ pip install .

Please Note: don't forget to install the required dependencies (see above).

To upgrade GOFit to the latest version, navigate to the top-level directory (i.e. the one containing setup.py) and re-run the installation using pip, as above:

$ git pull
$ pip install .

Testing

The documentation provides some simple examples of how to run GOFit.

Uninstallation

You can uninstall GOFit as follows:

$ pip uninstall gofit

Bugs

Please report any bugs using GitHub's issue tracker.

License

This software is released under the New BSD license.