Skip to content

Commit c92ab7e

Browse files
AndrewSazonovAndrewSazonov
committed
Update diagrams and clean up
1 parent 77e6722 commit c92ab7e

3 files changed

Lines changed: 159 additions & 590 deletions

File tree

‎docs/architecture/package-structure-full.md‎

Lines changed: 98 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,36 @@
1616
│ │ └── 📄 pdffit.py
1717
│ │ └── 🏷️ class PdffitCalculator
1818
│ ├── 📁 categories
19-
│ │ ├── 📄 __init__.py
20-
│ │ ├── 📄 aliases.py
21-
│ │ │ ├── 🏷️ class Alias
22-
│ │ │ └── 🏷️ class Aliases
23-
│ │ ├── 📄 constraints.py
24-
│ │ │ ├── 🏷️ class Constraint
25-
│ │ │ └── 🏷️ class Constraints
26-
│ │ └── 📄 joint_fit_experiments.py
27-
│ │ ├── 🏷️ class JointFitExperiment
28-
│ │ └── 🏷️ class JointFitExperiments
19+
│ │ ├── 📁 aliases
20+
│ │ │ ├── 📄 __init__.py
21+
│ │ │ ├── 📄 default.py
22+
│ │ │ │ ├── 🏷️ class Alias
23+
│ │ │ │ └── 🏷️ class Aliases
24+
│ │ │ └── 📄 factory.py
25+
│ │ │ └── 🏷️ class AliasesFactory
26+
│ │ ├── 📁 constraints
27+
│ │ │ ├── 📄 __init__.py
28+
│ │ │ ├── 📄 default.py
29+
│ │ │ │ ├── 🏷️ class Constraint
30+
│ │ │ │ └── 🏷️ class Constraints
31+
│ │ │ └── 📄 factory.py
32+
│ │ │ └── 🏷️ class ConstraintsFactory
33+
│ │ ├── 📁 fit_mode
34+
│ │ │ ├── 📄 __init__.py
35+
│ │ │ ├── 📄 enums.py
36+
│ │ │ │ └── 🏷️ class FitModeEnum
37+
│ │ │ ├── 📄 factory.py
38+
│ │ │ │ └── 🏷️ class FitModeFactory
39+
│ │ │ └── 📄 fit_mode.py
40+
│ │ │ └── 🏷️ class FitMode
41+
│ │ ├── 📁 joint_fit_experiments
42+
│ │ │ ├── 📄 __init__.py
43+
│ │ │ ├── 📄 default.py
44+
│ │ │ │ ├── 🏷️ class JointFitExperiment
45+
│ │ │ │ └── 🏷️ class JointFitExperiments
46+
│ │ │ └── 📄 factory.py
47+
│ │ │ └── 🏷️ class JointFitExperimentsFactory
48+
│ │ └── 📄 __init__.py
2949
│ ├── 📁 fit_helpers
3050
│ │ ├── 📄 __init__.py
3151
│ │ ├── 📄 metrics.py
@@ -46,9 +66,12 @@
4666
│ │ └── 🏷️ class LmfitMinimizer
4767
│ ├── 📄 __init__.py
4868
│ ├── 📄 analysis.py
69+
│ │ ├── 🏷️ class AnalysisDisplay
4970
│ │ └── 🏷️ class Analysis
50-
│ └── 📄 fitting.py
51-
│ └── 🏷️ class Fitter
71+
│ ├── 📄 fitting.py
72+
│ │ └── 🏷️ class Fitter
73+
│ └── 📄 sequential.py
74+
│ └── 🏷️ class SequentialFitTemplate
5275
├── 📁 core
5376
│ ├── 📄 __init__.py
5477
│ ├── 📄 category.py
@@ -73,7 +96,6 @@
7396
│ │ └── 🏷️ class CalculatorSupport
7497
│ ├── 📄 singleton.py
7598
│ │ ├── 🏷️ class SingletonBase
76-
│ │ ├── 🏷️ class UidMapHandler
7799
│ │ └── 🏷️ class ConstraintsHandler
78100
│ ├── 📄 validation.py
79101
│ │ ├── 🏷️ class DataTypeHints
@@ -134,6 +156,31 @@
134156
│ │ │ │ ├── 🏷️ class TotalDataPoint
135157
│ │ │ │ ├── 🏷️ class TotalDataBase
136158
│ │ │ │ └── 🏷️ class TotalData
159+
│ │ │ ├── 📁 diffrn
160+
│ │ │ │ ├── 📄 __init__.py
161+
│ │ │ │ ├── 📄 default.py
162+
│ │ │ │ │ └── 🏷️ class DefaultDiffrn
163+
│ │ │ │ └── 📄 factory.py
164+
│ │ │ │ └── 🏷️ class DiffrnFactory
165+
│ │ │ ├── 📁 excluded_regions
166+
│ │ │ │ ├── 📄 __init__.py
167+
│ │ │ │ ├── 📄 default.py
168+
│ │ │ │ │ ├── 🏷️ class ExcludedRegion
169+
│ │ │ │ │ └── 🏷️ class ExcludedRegions
170+
│ │ │ │ └── 📄 factory.py
171+
│ │ │ │ └── 🏷️ class ExcludedRegionsFactory
172+
│ │ │ ├── 📁 experiment_type
173+
│ │ │ │ ├── 📄 __init__.py
174+
│ │ │ │ ├── 📄 default.py
175+
│ │ │ │ │ └── 🏷️ class ExperimentType
176+
│ │ │ │ └── 📄 factory.py
177+
│ │ │ │ └── 🏷️ class ExperimentTypeFactory
178+
│ │ │ ├── 📁 extinction
179+
│ │ │ │ ├── 📄 __init__.py
180+
│ │ │ │ ├── 📄 factory.py
181+
│ │ │ │ │ └── 🏷️ class ExtinctionFactory
182+
│ │ │ │ └── 📄 shelx.py
183+
│ │ │ │ └── 🏷️ class ShelxExtinction
137184
│ │ │ ├── 📁 instrument
138185
│ │ │ │ ├── 📄 __init__.py
139186
│ │ │ │ ├── 📄 base.py
@@ -147,6 +194,19 @@
147194
│ │ │ │ └── 📄 tof.py
148195
│ │ │ │ ├── 🏷️ class TofScInstrument
149196
│ │ │ │ └── 🏷️ class TofPdInstrument
197+
│ │ │ ├── 📁 linked_crystal
198+
│ │ │ │ ├── 📄 __init__.py
199+
│ │ │ │ ├── 📄 default.py
200+
│ │ │ │ │ └── 🏷️ class LinkedCrystal
201+
│ │ │ │ └── 📄 factory.py
202+
│ │ │ │ └── 🏷️ class LinkedCrystalFactory
203+
│ │ │ ├── 📁 linked_phases
204+
│ │ │ │ ├── 📄 __init__.py
205+
│ │ │ │ ├── 📄 default.py
206+
│ │ │ │ │ ├── 🏷️ class LinkedPhase
207+
│ │ │ │ │ └── 🏷️ class LinkedPhases
208+
│ │ │ │ └── 📄 factory.py
209+
│ │ │ │ └── 🏷️ class LinkedPhasesFactory
150210
│ │ │ ├── 📁 peak
151211
│ │ │ │ ├── 📄 __init__.py
152212
│ │ │ │ ├── 📄 base.py
@@ -172,19 +232,7 @@
172232
│ │ │ │ │ └── 🏷️ class TotalGaussianDampedSinc
173233
│ │ │ │ └── 📄 total_mixins.py
174234
│ │ │ │ └── 🏷️ class TotalBroadeningMixin
175-
│ │ │ ├── 📄 __init__.py
176-
│ │ │ ├── 📄 excluded_regions.py
177-
│ │ │ │ ├── 🏷️ class ExcludedRegion
178-
│ │ │ │ └── 🏷️ class ExcludedRegions
179-
│ │ │ ├── 📄 experiment_type.py
180-
│ │ │ │ └── 🏷️ class ExperimentType
181-
│ │ │ ├── 📄 extinction.py
182-
│ │ │ │ └── 🏷️ class Extinction
183-
│ │ │ ├── 📄 linked_crystal.py
184-
│ │ │ │ └── 🏷️ class LinkedCrystal
185-
│ │ │ └── 📄 linked_phases.py
186-
│ │ │ ├── 🏷️ class LinkedPhase
187-
│ │ │ └── 🏷️ class LinkedPhases
235+
│ │ │ └── 📄 __init__.py
188236
│ │ ├── 📁 item
189237
│ │ │ ├── 📄 __init__.py
190238
│ │ │ ├── 📄 base.py
@@ -212,14 +260,26 @@
212260
│ │ └── 🏷️ class Experiments
213261
│ ├── 📁 structure
214262
│ │ ├── 📁 categories
215-
│ │ │ ├── 📄 __init__.py
216-
│ │ │ ├── 📄 atom_sites.py
217-
│ │ │ │ ├── 🏷️ class AtomSite
218-
│ │ │ │ └── 🏷️ class AtomSites
219-
│ │ │ ├── 📄 cell.py
220-
│ │ │ │ └── 🏷️ class Cell
221-
│ │ │ └── 📄 space_group.py
222-
│ │ │ └── 🏷️ class SpaceGroup
263+
│ │ │ ├── 📁 atom_sites
264+
│ │ │ │ ├── 📄 __init__.py
265+
│ │ │ │ ├── 📄 default.py
266+
│ │ │ │ │ ├── 🏷️ class AtomSite
267+
│ │ │ │ │ └── 🏷️ class AtomSites
268+
│ │ │ │ └── 📄 factory.py
269+
│ │ │ │ └── 🏷️ class AtomSitesFactory
270+
│ │ │ ├── 📁 cell
271+
│ │ │ │ ├── 📄 __init__.py
272+
│ │ │ │ ├── 📄 default.py
273+
│ │ │ │ │ └── 🏷️ class Cell
274+
│ │ │ │ └── 📄 factory.py
275+
│ │ │ │ └── 🏷️ class CellFactory
276+
│ │ │ ├── 📁 space_group
277+
│ │ │ │ ├── 📄 __init__.py
278+
│ │ │ │ ├── 📄 default.py
279+
│ │ │ │ │ └── 🏷️ class SpaceGroup
280+
│ │ │ │ └── 📄 factory.py
281+
│ │ │ │ └── 🏷️ class SpaceGroupFactory
282+
│ │ │ └── 📄 __init__.py
223283
│ │ ├── 📁 item
224284
│ │ │ ├── 📄 __init__.py
225285
│ │ │ ├── 📄 base.py
@@ -269,7 +329,8 @@
269329
│ │ │ └── 🏷️ class CifHandler
270330
│ │ ├── 📄 parse.py
271331
│ │ └── 📄 serialize.py
272-
│ └── 📄 __init__.py
332+
│ ├── 📄 __init__.py
333+
│ └── 📄 ascii.py
273334
├── 📁 project
274335
│ ├── 📄 __init__.py
275336
│ ├── 📄 project.py
@@ -288,6 +349,8 @@
288349
│ │ ├── 📄 __init__.py
289350
│ │ └── 📄 theme_detect.py
290351
│ ├── 📄 __init__.py
352+
│ ├── 📄 enums.py
353+
│ │ └── 🏷️ class VerbosityEnum
291354
│ ├── 📄 environment.py
292355
│ ├── 📄 logging.py
293356
│ │ ├── 🏷️ class IconifiedRichHandler

‎docs/architecture/package-structure-short.md‎

Lines changed: 61 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,24 @@
1111
│ │ ├── 📄 factory.py
1212
│ │ └── 📄 pdffit.py
1313
│ ├── 📁 categories
14-
│ │ ├── 📄 __init__.py
15-
│ │ ├── 📄 aliases.py
16-
│ │ ├── 📄 constraints.py
17-
│ │ └── 📄 joint_fit_experiments.py
14+
│ │ ├── 📁 aliases
15+
│ │ │ ├── 📄 __init__.py
16+
│ │ │ ├── 📄 default.py
17+
│ │ │ └── 📄 factory.py
18+
│ │ ├── 📁 constraints
19+
│ │ │ ├── 📄 __init__.py
20+
│ │ │ ├── 📄 default.py
21+
│ │ │ └── 📄 factory.py
22+
│ │ ├── 📁 fit_mode
23+
│ │ │ ├── 📄 __init__.py
24+
│ │ │ ├── 📄 enums.py
25+
│ │ │ ├── 📄 factory.py
26+
│ │ │ └── 📄 fit_mode.py
27+
│ │ ├── 📁 joint_fit_experiments
28+
│ │ │ ├── 📄 __init__.py
29+
│ │ │ ├── 📄 default.py
30+
│ │ │ └── 📄 factory.py
31+
│ │ └── 📄 __init__.py
1832
│ ├── 📁 fit_helpers
1933
│ │ ├── 📄 __init__.py
2034
│ │ ├── 📄 metrics.py
@@ -28,7 +42,8 @@
2842
│ │ └── 📄 lmfit.py
2943
│ ├── 📄 __init__.py
3044
│ ├── 📄 analysis.py
31-
│ └── 📄 fitting.py
45+
│ ├── 📄 fitting.py
46+
│ └── 📄 sequential.py
3247
├── 📁 core
3348
│ ├── 📄 __init__.py
3449
│ ├── 📄 category.py
@@ -62,12 +77,36 @@
6277
│ │ │ │ ├── 📄 bragg_sc.py
6378
│ │ │ │ ├── 📄 factory.py
6479
│ │ │ │ └── 📄 total_pd.py
80+
│ │ │ ├── 📁 diffrn
81+
│ │ │ │ ├── 📄 __init__.py
82+
│ │ │ │ ├── 📄 default.py
83+
│ │ │ │ └── 📄 factory.py
84+
│ │ │ ├── 📁 excluded_regions
85+
│ │ │ │ ├── 📄 __init__.py
86+
│ │ │ │ ├── 📄 default.py
87+
│ │ │ │ └── 📄 factory.py
88+
│ │ │ ├── 📁 experiment_type
89+
│ │ │ │ ├── 📄 __init__.py
90+
│ │ │ │ ├── 📄 default.py
91+
│ │ │ │ └── 📄 factory.py
92+
│ │ │ ├── 📁 extinction
93+
│ │ │ │ ├── 📄 __init__.py
94+
│ │ │ │ ├── 📄 factory.py
95+
│ │ │ │ └── 📄 shelx.py
6596
│ │ │ ├── 📁 instrument
6697
│ │ │ │ ├── 📄 __init__.py
6798
│ │ │ │ ├── 📄 base.py
6899
│ │ │ │ ├── 📄 cwl.py
69100
│ │ │ │ ├── 📄 factory.py
70101
│ │ │ │ └── 📄 tof.py
102+
│ │ │ ├── 📁 linked_crystal
103+
│ │ │ │ ├── 📄 __init__.py
104+
│ │ │ │ ├── 📄 default.py
105+
│ │ │ │ └── 📄 factory.py
106+
│ │ │ ├── 📁 linked_phases
107+
│ │ │ │ ├── 📄 __init__.py
108+
│ │ │ │ ├── 📄 default.py
109+
│ │ │ │ └── 📄 factory.py
71110
│ │ │ ├── 📁 peak
72111
│ │ │ │ ├── 📄 __init__.py
73112
│ │ │ │ ├── 📄 base.py
@@ -78,12 +117,7 @@
78117
│ │ │ │ ├── 📄 tof_mixins.py
79118
│ │ │ │ ├── 📄 total.py
80119
│ │ │ │ └── 📄 total_mixins.py
81-
│ │ │ ├── 📄 __init__.py
82-
│ │ │ ├── 📄 excluded_regions.py
83-
│ │ │ ├── 📄 experiment_type.py
84-
│ │ │ ├── 📄 extinction.py
85-
│ │ │ ├── 📄 linked_crystal.py
86-
│ │ │ └── 📄 linked_phases.py
120+
│ │ │ └── 📄 __init__.py
87121
│ │ ├── 📁 item
88122
│ │ │ ├── 📄 __init__.py
89123
│ │ │ ├── 📄 base.py
@@ -96,10 +130,19 @@
96130
│ │ └── 📄 collection.py
97131
│ ├── 📁 structure
98132
│ │ ├── 📁 categories
99-
│ │ │ ├── 📄 __init__.py
100-
│ │ │ ├── 📄 atom_sites.py
101-
│ │ │ ├── 📄 cell.py
102-
│ │ │ └── 📄 space_group.py
133+
│ │ │ ├── 📁 atom_sites
134+
│ │ │ │ ├── 📄 __init__.py
135+
│ │ │ │ ├── 📄 default.py
136+
│ │ │ │ └── 📄 factory.py
137+
│ │ │ ├── 📁 cell
138+
│ │ │ │ ├── 📄 __init__.py
139+
│ │ │ │ ├── 📄 default.py
140+
│ │ │ │ └── 📄 factory.py
141+
│ │ │ ├── 📁 space_group
142+
│ │ │ │ ├── 📄 __init__.py
143+
│ │ │ │ ├── 📄 default.py
144+
│ │ │ │ └── 📄 factory.py
145+
│ │ │ └── 📄 __init__.py
103146
│ │ ├── 📁 item
104147
│ │ │ ├── 📄 __init__.py
105148
│ │ │ ├── 📄 base.py
@@ -129,7 +172,8 @@
129172
│ │ ├── 📄 handler.py
130173
│ │ ├── 📄 parse.py
131174
│ │ └── 📄 serialize.py
132-
│ └── 📄 __init__.py
175+
│ ├── 📄 __init__.py
176+
│ └── 📄 ascii.py
133177
├── 📁 project
134178
│ ├── 📄 __init__.py
135179
│ ├── 📄 project.py
@@ -145,6 +189,7 @@
145189
│ │ ├── 📄 __init__.py
146190
│ │ └── 📄 theme_detect.py
147191
│ ├── 📄 __init__.py
192+
│ ├── 📄 enums.py
148193
│ ├── 📄 environment.py
149194
│ ├── 📄 logging.py
150195
│ └── 📄 utils.py

0 commit comments

Comments
 (0)