From f4d2c07a3c4d06c754bb76e3609c47e8bb1f82a4 Mon Sep 17 00:00:00 2001
From: Tobias Meisel <tobias.meisel@ufz.de>
Date: Wed, 20 Mar 2024 08:48:47 +0100
Subject: [PATCH] [logparser] Rename back to log parser
---
.../plot_logparser_advanced.py} | 6 +++---
.../plot_logparser_analyses.py} | 12 ++++++------
.../plot_logparser_intro.py} | 6 +++---
.../{studies/efficiency => logparser}/__init__.py | 0
.../efficiency => logparser}/common_ogs_analyses.py | 0
ogstools/logparser/examples/__init__.py | 8 ++++++++
.../{studies/efficiency => logparser}/log_parser.py | 2 +-
.../{studies/efficiency => logparser}/ogs_regexes.py | 0
8 files changed, 21 insertions(+), 13 deletions(-)
rename docs/examples/{howto_studies/plot_efficiency_study_advanced.py => howto_logparser/plot_logparser_advanced.py} (93%)
rename docs/examples/{howto_studies/plot_efficiency_study_analysis.py => howto_logparser/plot_logparser_analyses.py} (88%)
rename docs/examples/{howto_studies/plot_efficiency_study_intro.py => howto_logparser/plot_logparser_intro.py} (91%)
rename ogstools/{studies/efficiency => logparser}/__init__.py (100%)
rename ogstools/{studies/efficiency => logparser}/common_ogs_analyses.py (100%)
create mode 100644 ogstools/logparser/examples/__init__.py
rename ogstools/{studies/efficiency => logparser}/log_parser.py (98%)
rename ogstools/{studies/efficiency => logparser}/ogs_regexes.py (100%)
diff --git a/docs/examples/howto_studies/plot_efficiency_study_advanced.py b/docs/examples/howto_logparser/plot_logparser_advanced.py
similarity index 93%
rename from docs/examples/howto_studies/plot_efficiency_study_advanced.py
rename to docs/examples/howto_logparser/plot_logparser_advanced.py
index ac306dd88..cac0fa461 100644
--- a/docs/examples/howto_studies/plot_efficiency_study_advanced.py
+++ b/docs/examples/howto_logparser/plot_logparser_advanced.py
@@ -1,5 +1,5 @@
"""
-Efficiency study - Advanced topics
+Log parser - Advanced topics
==================================
This example shows how to analyse the OGS log output to get information
@@ -12,7 +12,7 @@ It uses a log file generated by ogs with project file from the following benchma
# %%
import pandas as pd
-from ogstools.studies.efficiency import (
+from ogstools.logparser import (
analysis_convergence_coupling_iteration,
analysis_convergence_newton_iteration,
analysis_time_step,
@@ -20,7 +20,7 @@ from ogstools.studies.efficiency import (
parse_file,
time_step_vs_iterations,
)
-from ogstools.studies.efficiency.examples import (
+from ogstools.logparser.examples import (
const_viscosity_thermal_convection_log,
)
diff --git a/docs/examples/howto_studies/plot_efficiency_study_analysis.py b/docs/examples/howto_logparser/plot_logparser_analyses.py
similarity index 88%
rename from docs/examples/howto_studies/plot_efficiency_study_analysis.py
rename to docs/examples/howto_logparser/plot_logparser_analyses.py
index 6be42b180..f66849f99 100644
--- a/docs/examples/howto_studies/plot_efficiency_study_analysis.py
+++ b/docs/examples/howto_logparser/plot_logparser_analyses.py
@@ -1,5 +1,5 @@
"""
-Efficiency study - Predefined Analyses
+Log parser - Predefined Analyses
=======================================
Here we shows the different predefined analysis available in the log parser.
@@ -14,7 +14,7 @@ and for the staggered scheme the variant taken from
# %%
import pandas as pd
-from ogstools.studies.efficiency import (
+from ogstools.logparser import (
analysis_convergence_coupling_iteration,
analysis_convergence_newton_iteration,
analysis_time_step,
@@ -22,8 +22,9 @@ from ogstools.studies.efficiency import (
parse_file,
time_step_vs_iterations,
)
-from ogstools.studies.efficiency.examples import (
+from ogstools.logparser.examples import (
const_viscosity_thermal_convection_log,
+ staggered_log,
)
# %%
@@ -59,9 +60,8 @@ analysis_convergence_newton_iteration(df_log)
# Staggered
# Tests/Data/Parabolic/HT/StaggeredCoupling/HeatTransportInStationaryFlow/HeatTransportInStationaryFlow.prj#
#
-records = parse_file(
- "/home/meisel/gitlabrepos/ogstools/staggered_heat_transport_in_stationary_flow.log"
-)
+log = staggered_log
+records = parse_file(log)
df_records = pd.DataFrame(records)
df_log = fill_ogs_context(df_records)
diff --git a/docs/examples/howto_studies/plot_efficiency_study_intro.py b/docs/examples/howto_logparser/plot_logparser_intro.py
similarity index 91%
rename from docs/examples/howto_studies/plot_efficiency_study_intro.py
rename to docs/examples/howto_logparser/plot_logparser_intro.py
index 5755a48e6..bce9a3f13 100644
--- a/docs/examples/howto_studies/plot_efficiency_study_intro.py
+++ b/docs/examples/howto_logparser/plot_logparser_intro.py
@@ -1,5 +1,5 @@
"""
-Efficiency study - Introduction
+Log parser - Introduction
================================
This basic example shows a how to analyse the OGS log output to get information
@@ -13,12 +13,12 @@ It uses the project file from the following benchmark:
# %%
import pandas as pd
-from ogstools.studies.efficiency import (
+from ogstools.logparser import (
fill_ogs_context,
parse_file,
time_step_vs_iterations,
)
-from ogstools.studies.efficiency.examples import (
+from ogstools.logparser.examples import (
const_viscosity_thermal_convection_log,
)
diff --git a/ogstools/studies/efficiency/__init__.py b/ogstools/logparser/__init__.py
similarity index 100%
rename from ogstools/studies/efficiency/__init__.py
rename to ogstools/logparser/__init__.py
diff --git a/ogstools/studies/efficiency/common_ogs_analyses.py b/ogstools/logparser/common_ogs_analyses.py
similarity index 100%
rename from ogstools/studies/efficiency/common_ogs_analyses.py
rename to ogstools/logparser/common_ogs_analyses.py
diff --git a/ogstools/logparser/examples/__init__.py b/ogstools/logparser/examples/__init__.py
new file mode 100644
index 000000000..c930c81f8
--- /dev/null
+++ b/ogstools/logparser/examples/__init__.py
@@ -0,0 +1,8 @@
+from importlib import resources
+
+_prefix = resources.files(__name__)
+liquid_flow_log = _prefix / "ogs.log"
+const_viscosity_thermal_convection_log = (
+ _prefix / "ConstViscosityThermalConvection.log"
+)
+staggered_log = "staggered_heat_transport_in_stationary_flow.log"
diff --git a/ogstools/studies/efficiency/log_parser.py b/ogstools/logparser/log_parser.py
similarity index 98%
rename from ogstools/studies/efficiency/log_parser.py
rename to ogstools/logparser/log_parser.py
index 3eecb1d85..0be73a428 100644
--- a/ogstools/studies/efficiency/log_parser.py
+++ b/ogstools/logparser/log_parser.py
@@ -7,7 +7,7 @@ import re
from pathlib import Path
from typing import Any, Optional, Union
-from ogstools.studies.efficiency.ogs_regexes import ogs_regexes
+from ogstools.logparser.ogs_regexes import ogs_regexes
def _try_match_parallel_line(
diff --git a/ogstools/studies/efficiency/ogs_regexes.py b/ogstools/logparser/ogs_regexes.py
similarity index 100%
rename from ogstools/studies/efficiency/ogs_regexes.py
rename to ogstools/logparser/ogs_regexes.py
--
GitLab