/*

MIT License

Copyright 2018, Intel Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in 
the Software without restriction, including without limitation the rights to 
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
of the Software, and to permit persons to whom the Software is furnished to do 
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
SOFTWARE.

*/

#################################################################################

Author: Justin Gottschlich, Intel Labs (justin.gottschlich@intel.com)

What is DATSA?

DATSA (Data Aggregator for Time Series Anomalies) is a tool to help anomaly 
detection engineers and scientists quickly generate synthetic time series data 
for the anomaly types they are interested in.

Please see the DATSA tutorial for a detailed explanation of how to use DATSA:

  /docs/DATSA_tutorial.v1.0.pdf

The below explanation is intended for advanced C++ programmers or anomaly detection
experts who can dive in immediately without much background.

#################################################################################
The DATSA code is distributed in the following manner:

Root directory (this directory) -> contains directories to use DATSA

/src -> contains the actual DATSA source needed to generate data
/examples -> contains many examples using DATSA

#################################################################################
To build DATSA using some of the examples:

cd examples
<edit main.cpp to include / exclude examples>
<add new example files to the Makefile>
make clean; make
./datsa

#################################################################################
To clean the DATSA project and rebuild:

cd examples
make clean
make

#################################################################################
To use DATSA to generate your own data:

Pull all the source code from the /src directory. 

Include the following files in your project:

  #include "src/data_generator.h"
  #include "src/function_variable.h"
  #include "src/event_data.h"

For more detailed instructions please see the DATSA tutorial.

#################################################################################