From dd478bbed0c051d6d843befa8fa10745e849bcfc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Al=C3=A1n=20Mu=C3=B1oz?= <amuoz@ed.ac.uk> Date: Mon, 23 May 2022 10:35:18 +0100 Subject: [PATCH] add .readthedocs and other conveniences --- core/group.py | 4 ++-- core/multisignal/__init__.py | 3 +++ core/report.py | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 core/multisignal/__init__.py diff --git a/core/group.py b/core/group.py index 09aa5d9d..3d145e42 100644 --- a/core/group.py +++ b/core/group.py @@ -1,5 +1,5 @@ """ -Class to group multiple positions into one using one of several criteria. +Class to group multiple positions into one using one different available criteria. """ from pathlib import Path @@ -9,7 +9,7 @@ import h5py import pandas as pd from agora.io.bridge import groupsort -from postprocessor.core.io.signal import Signal +from agora.io.signal import Signal from postprocessor.core.abc import ParametersABC, ProcessABC diff --git a/core/multisignal/__init__.py b/core/multisignal/__init__.py new file mode 100644 index 00000000..a2aa9b57 --- /dev/null +++ b/core/multisignal/__init__.py @@ -0,0 +1,3 @@ +""" +Collection of processes that work on multiple signals. +""" diff --git a/core/report.py b/core/report.py index 51922f86..b0963a70 100644 --- a/core/report.py +++ b/core/report.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 """ -System that produce a report summarising the results of an experiment. +Automatic summarissed report to condense results of an experiment. It should NOT contain text beyond labels and titles. The most efficient way to communicate information is (inteligently) colour-coded figures and tables. -- GitLab