From 4db394b64da52f54c50fabafde3cdc2ab701c1c9 Mon Sep 17 00:00:00 2001
From: Branislav Jansik <branislav.jansik@vsb.cz>
Date: Wed, 6 Sep 2017 15:38:27 +0200
Subject: [PATCH] Resource accounting extracted as a snippet

---
 docs.it4i/snippets/resource_accounting.md | 61 +++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 docs.it4i/snippets/resource_accounting.md

diff --git a/docs.it4i/snippets/resource_accounting.md b/docs.it4i/snippets/resource_accounting.md
new file mode 100644
index 000000000..611be3992
--- /dev/null
+++ b/docs.it4i/snippets/resource_accounting.md
@@ -0,0 +1,61 @@
+## Resource Accounting Policy
+
+### Wall-clock Core-Hours WCH
+
+The wall-clock core-hours (WCH) are the basic metric of computer utilization time.
+1 wall-clock core-hour is defined as 1 processor core allocated for 1 hour of wall-clock time. Allocating a full node (24 cores)
+for 1 hour amounts to 24 wall-clock core-hours.
+
+### Standard Core-Hours SCH
+
+The resources subject to accounting are the standard core-hours (SCH).
+The standard core-hours are obtained from WCH by applying a standardization factor:
+
+---8<--- "sch_formula.md"
+
+The accounting runs whenever the computational cores are allocated via the PBS Pro workload manager (the qsub command), regardless of whether
+the cores are actually used for any calculation. All jobs are accounted in standard core-hours, using factor F valid at the time of the execution:
+
+| System                          | F   | Validity |
+| ------------------------------- | -   | -------- |
+| Salomon                         | 1.00 |  2017-09-11 to 2018-06-01 |
+| Anselm                          | 0.65 |  2017-09-11 to 2018-06-01 |
+
+!!! note
+    The allocations are requested/granted in standard core-hours SCH.
+
+Whenever the term core-hour is used in this documentation, we mean the standard core-hour, SCH.
+
+The standard core-hours were introduced to treat systems of different age on equal footing.
+Standard core-hour is an accounting tool to discount the legacy systems. The past (before 2017-09-11) F factors are all 1.0.
+In future, the factors F will be updated, as new systems are installed. Factors F are expected to only decrease in time.
+
+See examples in the [Job submission and execution](job-submission-and-execution/) section.
+
+### Consumed Resources
+
+User may check at any time, how many core-hours have been consumed by himself/herself and his/her projects. The command is available on cluster login nodes.
+
+```console
+$ it4ifree
+
+Projects I am participating in
+==============================
+PID         Days left      Total    Used WCHs    Used SCHs    WCHs by me    SCHs by me     Free
+----------  -----------  -------  -----------  -----------  ------------  ------------  -------
+OPEN-XX-XX  323                0      5169947      5169947         50001         50001  1292555
+
+
+Projects I am Primarily Investigating
+=====================================
+PID         Login         Used WCHs    Used SCHs
+----------  ----------  -----------  -----------
+OPEN-XX-XX  user1            376670       376670
+            user2           4793277      4793277
+
+Legend
+======
+WCH   =    Wall-clock Core Hour
+SCH   =    Standard Core Hour
+```
+The **it4ifree** command is a part of it4i.portal.clients package, located here: <https://pypi.python.org/pypi/it4i.portal.clients>
\ No newline at end of file
-- 
GitLab