Metadata-Version: 2.4
Name: mobts
Version: 0.1.7
Summary: Mobility time series package for preprocessing, imputing, and analyzing mobility count observation data
Author: Ali SHATERI BENAM
Project-URL: Documentation, https://mobidec.github.io/mobts/index.html
Project-URL: Repository, https://github.com/Mobidec/mobts.git
Project-URL: Issues, https://github.com/Mobidec/mobts/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: statsmodels
Requires-Dist: scikit-learn
Requires-Dist: matplotlib
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_design; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: sphinx_autopackagesummary; extra == "dev"
Requires-Dist: sphinxcontrib-napoleon; extra == "dev"
Requires-Dist: numpydoc; extra == "dev"
Requires-Dist: myst_nb; extra == "dev"
Dynamic: license-file

# mobts

> Python package for preprocessing and imputing urban mobility time series data.

Designed for transport datasets such as bike counts, traffic loops, and station-based observations.

---

## What this package does

- Clean time series data:
 + Detects measurement errors
 + Flags and removes them 

- Imputes missing/invalid data based on a multi-tier method

---

## Installation
```bash
pip install mobts
```
---

## Example of running the code
```bash
from mobts import preprocess
from mobts import impute
```

# Step 1: clean raw data
```bash
pp = preprocess()
df_clean = pp.run(df)
```

# Step 2: impute missing values
```bash
imp = impute()
df_imputed = imp.run(df_clean)
```
---

### Functional examples

Full step-by-step examples are available in:
 - notebooks/demo_preprocessing_imputation.ipynb

## License

This project is licensed under the MIT License, which means it is freely usable for personal and commercial purposes. The MIT License is one of the most permissive open source licenses. It allows you to do almost anything with the source code, as long as you retain the original license notice and copyright information when redistributing the software or substantial portions of it. This license comes without any warranties, so the software is provided "as is." For more details, please refer to the included LICENSE file.
