CSIT-1110: Use jumpavg library from pip

[csit.git] / PyPI / jumpavg / README.rst

diff --git a/PyPI/jumpavg/README.rst b/PyPI/jumpavg/README.rst
new file mode 100644 (file)
index 0000000..2bdde2b
--- /dev/null
+++ b/PyPI/jumpavg/README.rst
@@ -0,0 +1,28 @@
+Jumpavg library
+===============
+
+Origins
+-------
+
+This library was developed as anomaly detection logic
+for PAL_ (Presentation and Analysis Layer)
+of CSIT_ (Continuous System and Integration Testing)
+project of fd.io_ (Fast Data), one of LFN_
+(Linux Foundation Networking) projects.
+
+In order to make this code available in PyPI_ (Python Package Index),
+the setuputils stuff has been added,
+and the code has been moved into a separate directory_,
+in order to not intervere of otherwise tightly coupled CSIT code.
+
+Usage
+-----
+
+TODO.
+
+.. _PAL: https://wiki.fd.io/view/CSIT/Design_Optimizations#Presentation_and_Analytics_Layer
+.. _CSIT: https://wiki.fd.io/view/CSIT
+.. _fd.io: https://fd.io/
+.. _LFN: https://www.linuxfoundation.org/projects/networking/
+.. _PyPI: https://pypi.org/
+.. _directory: https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/jumpavg;hb=refs/heads/master