Metadata-Version: 2.1
Name: ts-app
Version: 0.0.1
Summary: A simple dashboard app to interactively fit ARIMA models.
Home-page: https://github.com/Tim-Abwao/time-series-app
Author: Abwao
Author-email: abwaomusungu@gmail.com
License: MIT
Keywords: time_series dashboard ARIMA
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Dash
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: dash
Requires-Dist: gunicorn
Requires-Dist: pandas
Requires-Dist: statsmodels

# Time Series App

A simple web app to learn a little about *[Time Series][1] analysis* and *forecasting*.

You can create a sample, or upload a file, and interactively fit a time series model on it. To give it a try, [click here...][2]

![screencast of the app](dashboard.gif)

## Running locally

### Prerequisites

- [Python][3] 3.8 and above. Packages used include [statsmodels][4], [flask][5], [dash][8], [pandas][6] and [NumPy][7].

1. Fetching necessary files:

    ```bash
    git clone https://github.com/Tim-Abwao/time-series-app.git
    cd time-series-app
    ```

2. Setting up a virtual environment:

    ```bash
    python3 -m venv venv
    source venv/bin/activate
    pip install -U pip
    pip install -r requirements.txt
    ```

3. Starting the app:

    - You can use the convenient `run.sh` script:

        ```bash
        bash run.sh
        ```

        then browse to [localhost:8000](http://127.0.0.1:8000) to interact with the web app.

    - You can also use [Docker][9]:

        ```bash
        docker build --tag ts_app .
        docker run --name ts -d -p 8000:8000 --rm  ts_app
        ```

        in which case the app will be running at <http://0.0.0.0:8000>.

[1]: https://en.wikipedia.org/wiki/Time_series
[2]: https://time-series-app.herokuapp.com
[3]: https://www.python.org "The Python programming language"
[4]: https://www.statsmodels.org/stable/index.html
[5]: https://flask.palletsprojects.com/en/1.1.x/
[6]: https://pandas.pydata.org
[7]: https://numpy.org
[8]: https://dash.plotly.com/
[9]: https://www.docker.com/


