scipy-data_fitting 0.2.4

Documentation

Documentation generated from source with pdoc for the latest version is hosted at packages.python.org/scipy-data_fitting/.

To get started quickly, check out the examples.

Then, refer to the source documentation for details on how to use each class.

Basic usage

from scipy_data_fitting import Data, Model, Fit, Plot

# Load data from a CSV file.
data = Data('linear')
data.path = 'linear.csv'
data.error = (0.5, None)

# Create a linear model.
model = Model('linear')
model.add_symbols('t', 'v', 'x_0')
t, v, x_0 = model.get_symbols('t', 'v', 'x_0')
model.expressions['line'] = v * t + x_0

# Create the fit using the data and model.
fit = Fit('linear', data=data, model=model)
fit.expression = 'line'
fit.independent = {'symbol': 't', 'name': 'Time', 'units': 's'}
fit.dependent = {'name': 'Distance', 'units': 'm'}
fit.parameters = [
    {'symbol': 'v', 'guess': 1, 'units': 'm/s'},
    {'symbol': 'x_0', 'value': 1, 'units': 'm'},
]

# Save the fit result to a json file.
fit.to_json(fit.name + '.json', meta=fit.metadata)

# Save a plot of the fit to an image file.
plot = Plot(fit)
plot.save(fit.name + '.svg')
plot.close()

fit.parameters = [
    {'symbol': 'v', 'guess': 1, 'units': 'm/s'},
    {'symbol': 'x_0', 'guess': 1, 'units': 'm'},
]
fit.options['fit_function'] = lambda f, x, y, p0, **op: (numpy.polyfit(x, y, 1), )

Installation

This package is registered on the Python Package Index (PyPI) at pypi.python.org/pypi/scipy-data_fitting.

Add this line to your application’s requirements.txt:

scipy-data_fitting

And then execute:

$ pip install -r requirements.txt

Or install it yourself as:

$ pip install scipy-data_fitting

Depending on your system configuration, you may need to run the above commands with sudo. Alternatively, you may want to use a virtualenv, which is beyond the scope of this documentation.

Note that the large scientific packages such as NumPy, SciPy, and matplotlib may also be available via your system’s package manager.

To live on the bleeding edge, instead of the package name scipy-data_fitting, you can use this repository directly with

git+https://github.com/razor-x/scipy-data_fitting.git@master#egg=scipy-data_fitting

Development

$ git clone https://github.com/razor-x/scipy-data_fitting.git

$ pip install -r requirements.txt

$ python setup.py develop

$ make docs

$ make tests

$ python examples/example_fit.py

$ make examples

License

This code is licensed under the MIT license.

Warranty

This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.