From 647ec9834c6ebe8665634fc68e658a74427c5321 Mon Sep 17 00:00:00 2001 From: uvchik Date: Fri, 19 Feb 2021 12:17:39 +0100 Subject: [PATCH] Add usage chapter (work in progress) --- docs/usage.rst | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index 693794b8..b6759a6a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,6 +2,30 @@ Usage ===== -To use deflex in a project:: +THIS CHAPTER IS WORK IN PROGRESS... + +.. contents:: + :depth: 2 + :local: + :backlinks: top + +DeflexScenario +++++++++++++++ + +The scenario class DeflexScenario is a central element of a deflexletzte + +In deflex all input data is stored as a dictionary of pandas ``DataFrame`` in +the ``table_collection`` attribute of the ``DeflexScenario`` class. + +[TODO: add reference to DeflexScenario] + +At the moment, there are two methods to populate this attribute from a file: + +* read_csv() - to read a directory with all needed csv files. +* read_excel() - to read a spread sheet. + +[TODO: only xlsx is possible, so xlsx is better than excel because it works for +Libreoffice, too.] + +... - Coming soon