Skip to content

Commit 0f16d61

Browse files
committed
Reorganizes display and logging structure
1 parent 617f00f commit 0f16d61

File tree

2 files changed

+56
-24
lines changed

2 files changed

+56
-24
lines changed

docs/architecture/package-structure-full.md

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
│ │ ├── 📄 reporting.py
3333
│ │ │ └── 🏷️ class FitResults
3434
│ │ └── 📄 tracking.py
35+
│ │ ├── 🏷️ class _TerminalLiveHandle
3536
│ │ └── 🏷️ class FitProgressTracker
3637
│ ├── 📁 minimizers
3738
│ │ ├── 📄 __init__.py
@@ -93,6 +94,37 @@
9394
│ ├── 📄 __init__.py
9495
│ ├── 📄 crystallography.py
9596
│ └── 📄 space_groups.py
97+
├── 📁 display
98+
│ ├── 📁 plotters
99+
│ │ ├── 📄 __init__.py
100+
│ │ ├── 📄 ascii.py
101+
│ │ │ └── 🏷️ class AsciiPlotter
102+
│ │ ├── 📄 base.py
103+
│ │ │ └── 🏷️ class PlotterBase
104+
│ │ └── 📄 plotly.py
105+
│ │ └── 🏷️ class PlotlyPlotter
106+
│ ├── 📁 tablers
107+
│ │ ├── 📄 __init__.py
108+
│ │ ├── 📄 base.py
109+
│ │ │ └── 🏷️ class TableBackendBase
110+
│ │ ├── 📄 pandas.py
111+
│ │ │ └── 🏷️ class PandasTableBackend
112+
│ │ └── 📄 rich.py
113+
│ │ └── 🏷️ class RichTableBackend
114+
│ ├── 📄 __init__.py
115+
│ ├── 📄 base.py
116+
│ │ ├── 🏷️ class RendererBase
117+
│ │ └── 🏷️ class RendererFactoryBase
118+
│ ├── 📄 plotting.py
119+
│ │ ├── 🏷️ class PlotterEngineEnum
120+
│ │ ├── 🏷️ class Plotter
121+
│ │ └── 🏷️ class PlotterFactory
122+
│ ├── 📄 tables.py
123+
│ │ ├── 🏷️ class TableEngineEnum
124+
│ │ ├── 🏷️ class TableRenderer
125+
│ │ └── 🏷️ class TableRendererFactory
126+
│ └── 📄 utils.py
127+
│ └── 🏷️ class JupyterScrollManager
96128
├── 📁 experiments
97129
│ ├── 📁 categories
98130
│ │ ├── 📁 background
@@ -192,19 +224,6 @@
192224
│ ├── 📄 handler.py
193225
│ │ └── 🏷️ class CifHandler
194226
│ └── 📄 serialize.py
195-
├── 📁 plotting
196-
│ ├── 📁 plotters
197-
│ │ ├── 📄 __init__.py
198-
│ │ ├── 📄 plotter_ascii.py
199-
│ │ │ └── 🏷️ class AsciiPlotter
200-
│ │ ├── 📄 plotter_base.py
201-
│ │ │ └── 🏷️ class PlotterBase
202-
│ │ └── 📄 plotter_plotly.py
203-
│ │ └── 🏷️ class PlotlyPlotter
204-
│ ├── 📄 __init__.py
205-
│ └── 📄 plotting.py
206-
│ ├── 🏷️ class Plotter
207-
│ └── 🏷️ class PlotterFactory
208227
├── 📁 project
209228
│ ├── 📄 __init__.py
210229
│ ├── 📄 project.py
@@ -236,9 +255,14 @@
236255
│ └── 🏷️ class Summary
237256
├── 📁 utils
238257
│ ├── 📄 __init__.py
239-
│ ├── 📄 formatting.py
258+
│ ├── 📄 environment.py
240259
│ ├── 📄 logging.py
241-
│ │ └── 🏷️ class Logger
260+
│ │ ├── 🏷️ class IconifiedRichHandler
261+
│ │ ├── 🏷️ class ConsoleManager
262+
│ │ ├── 🏷️ class LoggerConfig
263+
│ │ ├── 🏷️ class ExceptionHookManager
264+
│ │ ├── 🏷️ class Logger
265+
│ │ └── 🏷️ class ConsolePrinter
242266
│ └── 📄 utils.py
243267
├── 📄 __init__.py
244268
└── 📄 __main__.py

docs/architecture/package-structure-short.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,22 @@
4646
│ ├── 📄 __init__.py
4747
│ ├── 📄 crystallography.py
4848
│ └── 📄 space_groups.py
49+
├── 📁 display
50+
│ ├── 📁 plotters
51+
│ │ ├── 📄 __init__.py
52+
│ │ ├── 📄 ascii.py
53+
│ │ ├── 📄 base.py
54+
│ │ └── 📄 plotly.py
55+
│ ├── 📁 tablers
56+
│ │ ├── 📄 __init__.py
57+
│ │ ├── 📄 base.py
58+
│ │ ├── 📄 pandas.py
59+
│ │ └── 📄 rich.py
60+
│ ├── 📄 __init__.py
61+
│ ├── 📄 base.py
62+
│ ├── 📄 plotting.py
63+
│ ├── 📄 tables.py
64+
│ └── 📄 utils.py
4965
├── 📁 experiments
5066
│ ├── 📁 categories
5167
│ │ ├── 📁 background
@@ -96,14 +112,6 @@
96112
│ └── 📁 cif
97113
│ ├── 📄 handler.py
98114
│ └── 📄 serialize.py
99-
├── 📁 plotting
100-
│ ├── 📁 plotters
101-
│ │ ├── 📄 __init__.py
102-
│ │ ├── 📄 plotter_ascii.py
103-
│ │ ├── 📄 plotter_base.py
104-
│ │ └── 📄 plotter_plotly.py
105-
│ ├── 📄 __init__.py
106-
│ └── 📄 plotting.py
107115
├── 📁 project
108116
│ ├── 📄 __init__.py
109117
│ ├── 📄 project.py
@@ -125,7 +133,7 @@
125133
│ └── 📄 summary.py
126134
├── 📁 utils
127135
│ ├── 📄 __init__.py
128-
│ ├── 📄 formatting.py
136+
│ ├── 📄 environment.py
129137
│ ├── 📄 logging.py
130138
│ └── 📄 utils.py
131139
├── 📄 __init__.py

0 commit comments

Comments
 (0)