Metadata-Version: 2.1
Name: deFit
Version: 0.1.0
Summary: Fitting Differential Equations to Time Series Data
Home-page: https://github.com/yueqinhu/defit
Author: Yueqin Hu
Author-email: yueqinhu@bnu.edu.cn
License: GPL-3
Project-URL: Documentation, https://github.com/yueqinhu/defit/blob/main/Documents/UserGuidePython.md
Keywords: ordinary differential equation,optimization,numerical methods,Intensive longitudinal data,dynamical system,time series
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Welcome to deFit

Fitting Differential Equations to Time Series Data ([deFit](https://github.com/yueqinhu/defit)).

## Overview
### What is deFit?
Use numerical optimization to fit ordinary differential equations (ODEs) to time series data to examine the dynamic relationships between variables or the characteristics of a dynamical system. It can now be used to estimate the parameters of ODEs up to second order.

### Features
* Fit ordinary differential equation models to time series data 
* Report model parameter estimations, standard errors, R-squared, and root mean standard error
* Plot raw data points and fitted lines
* Support ordinary differential equation models up to second order
* deFit can run in Python and R environments

### First impression in Python
To get a first impression of how deFit works in simulation, consider the following example of a differential equational model. The figure below contains a graphical representation of the model that we want to fit.
```python
import defit
import pandas as pd
df1 = pd.read_csv('defit/data/example1.csv')
model1 = '''
            x =~ myX
            time =~ myTime
            x(2) ~ x + x(1)
        '''
result1 = defit.defit(data=df1,model=model1)
```
![example1](https://raw.githubusercontent.com/yueqinhu/defit/main/img/example1_python.png)


## Navigation
- [Home](https://github.com/yueqinhu/defit)
- [User guide in R](https://github.com/yueqinhu/defit/blob/main/Documents/UserGuideR.md)
- [User guide in Python](https://github.com/yueqinhu/defit/blob/main/Documents/UserGuidePython.md)
- [Issues](https://github.com/yueqinhu/defit/issues)


