aboutsummaryrefslogtreecommitdiffstats
path: root/PyPI/jumpavg/README.rst
diff options
context:
space:
mode:
authorVratko Polak <vrpolak@cisco.com>2018-06-14 14:04:03 +0200
committerTibor Frank <tifrank@cisco.com>2018-06-15 10:44:11 +0000
commit6149ec451efff00068f38e3343e66cdec7b943f4 (patch)
treeec51cb4339782d37889f29383f303f9bdf35faa0 /PyPI/jumpavg/README.rst
parent2f99b522d591a95d6ac4f11db8a34b8162258ecd (diff)
CSIT-1110: Use jumpavg library from pip
+ Move the jumpavg library code to separate directory. - Bump to 0.1.2 has to be done later. Change-Id: I9722ede48f00e99eeb68ca3f91e0bdeee2937973 Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'PyPI/jumpavg/README.rst')
-rw-r--r--PyPI/jumpavg/README.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/PyPI/jumpavg/README.rst b/PyPI/jumpavg/README.rst
new file mode 100644
index 0000000000..2bdde2b9d0
--- /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