[tor-commits] [sbws/master] docs: Add bandwidth distribution documentation

[juga at torproject.org]

commit 733e8c3a9262cdb2c49ea7bae6c09a2ccbc818ed
Author: juga0 <juga at riseup.net>
Date:   Tue Feb 12 09:59:12 2019 +0000

    docs: Add bandwidth distribution documentation
---
 docs/source/bandwidth_distribution.rst             |  38 +++++++++++++++++++++
 docs/source/images/20180901_163442.png             | Bin 0 -> 38517 bytes
 docs/source/images/20180901_164014.png             | Bin 0 -> 43522 bytes
 ...710932-ac1eeea8-9960-11e8-9e7e-21fddff2f7a3.png | Bin 0 -> 38367 bytes
 ...710933-ac95e0bc-9960-11e8-9aaf-0bb1f83b65e2.png | Bin 0 -> 33525 bytes
 5 files changed, 38 insertions(+)

diff --git a/docs/source/bandwidth_distribution.rst b/docs/source/bandwidth_distribution.rst
new file mode 100644
index 0000000..ef54c9f
--- /dev/null
+++ b/docs/source/bandwidth_distribution.rst
@@ -0,0 +1,38 @@
+Relays' bandwidth distribution
+===================================
+
+sbws raw measurements compared to Torflow measurements
+------------------------------------------------------
+
+.. image:: images/43710932-ac1eeea8-9960-11e8-9e7e-21fddff2f7a3.png
+   :alt: sbws and torflow raw measurements distribution
+
+
+.. image:: images/43710933-ac95e0bc-9960-11e8-9aaf-0bb1f83b65e2.png
+   :alt: sbws and torflow raw measurements distribution 2
+
+
+sbws linear scaling
+--------------------
+
+Multiply each relay bandwidth by ``7500/median``
+
+See bandwidth_file_spec_ appendix B to know how about linear scaling.
+
+Code: :func:`sbws.lib.v3bwfile.sbws_scale`
+
+.. image:: images/20180901_163442.png
+   :alt: sbws linear scaling
+
+
+sbws Torflow scaling
+-----------------------
+
+See bandwidth_file_spec_ appendix B to know how about torflow scaling.
+
+Code: :func:`sbws.lib.v3bwfile.torflow_scale`
+
+.. image:: images/20180901_164014.png
+   :alt: sbws torflow scaling
+
+.. _bandwidth_file_spec: https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-spec.txt
diff --git a/docs/source/images/20180901_163442.png b/docs/source/images/20180901_163442.png
new file mode 100644
index 0000000..315e1d6
Binary files /dev/null and b/docs/source/images/20180901_163442.png differ
diff --git a/docs/source/images/20180901_164014.png b/docs/source/images/20180901_164014.png
new file mode 100644
index 0000000..f5d212d
Binary files /dev/null and b/docs/source/images/20180901_164014.png differ
diff --git a/docs/source/images/43710932-ac1eeea8-9960-11e8-9e7e-21fddff2f7a3.png b/docs/source/images/43710932-ac1eeea8-9960-11e8-9e7e-21fddff2f7a3.png
new file mode 100644
index 0000000..f79fc65
Binary files /dev/null and b/docs/source/images/43710932-ac1eeea8-9960-11e8-9e7e-21fddff2f7a3.png differ
diff --git a/docs/source/images/43710933-ac95e0bc-9960-11e8-9aaf-0bb1f83b65e2.png b/docs/source/images/43710933-ac95e0bc-9960-11e8-9aaf-0bb1f83b65e2.png
new file mode 100644
index 0000000..45b8e46
Binary files /dev/null and b/docs/source/images/43710933-ac95e0bc-9960-11e8-9aaf-0bb1f83b65e2.png differ