Metadata-Version: 2.1
Name: sam
Version: 2.10.2
Summary: Time series anomaly detection and forecasting
Home-page: https://github.com/RoyalHaskoningDHV/sam
Author: Royal HaskoningDHV
Author-email: arjan.bontsema@rhdhv.com
License: MIT
Project-URL: Q&A, https://github.com/RoyalHaskoningDHV/sam/discussions
Project-URL: Issues, https://github.com/RoyalHaskoningDHV/sam/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: all
Provides-Extra: plotting
Provides-Extra: data_engineering
Provides-Extra: data_science
License-File: LICENSE

# SAM

SAM is a Python package for timeseries analysis, anomaly detection and forecasting.

Author: [Royal HaskoningDHV](https://global.royalhaskoningdhv.com/digital)

Email: [arjan.bontsema@rhdhv.com](mailto:arjan.bontsema@rhdhv.com)

Contributors: Daan van Es, Arjan Bontsema, Ruben Peters, Ruud Kassing, Miguel Hernandez

## Getting started

The documentation is available [here.](https://samdocs.digitalapps.royalhaskoningdhv.com) Just ignore the certificate error for now.

To install the package, you need to have access to the Azure Devops projects. Then, add a pip.ini (Windows) or pip.conf (Mac/Linux) file to your virtualenv. This file should have the following lines of text:

```
[global]
extra-index-url=https://pkgs.dev.azure.com/corporateroot/SAM/_packaging/SAM/pypi/simple/
```

Also, make sure to install the azure keyring: `pip install keyring artifacts-keyring`. Now you can install with `pip install sam`.

There are different optional dependencies for SAM, if you are unsure us `pip install sam[all]` other options include `plotting` (just use the plotting functionality), `data_science` (all dependencies needed for a data scientist) and `data_engineering` (dependencies for data engineer).

Keep in mind that the sam package is updated frequently, and after a while, your local version may be out of date with the online documentation. To be sure, run the `pip install -U sam` command to install the latest version.

## Configuration

A configuration file can be created as `.config`. This configuration file only stores api credentials for now, but more options may be added in the future. The configuration file is parsed using the [Python3 configparser](https://docs.python.org/3/library/configparser.html), and an example configuration is shown below:

```
[regenradar]
user=regenradar.username
password=secret123

[openweathermap]
apikey=secret456
```

## Issue tracking and Feature Requests

Anyone can create feature requests or bug reports! You can browse and create new issues in Devops: https://dev.azure.com/corporateroot/SAM/_workitems/
