morphogen 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (381) hide show
  1. morphogen/__init__.py +60 -0
  2. morphogen/__main__.py +7 -0
  3. morphogen/_platform.py +55 -0
  4. morphogen/_public.py +153 -0
  5. morphogen/_utils.py +80 -0
  6. morphogen/_version.py +1 -0
  7. morphogen/analysis/__init__.py +174 -0
  8. morphogen/analysis/anisotropy.py +135 -0
  9. morphogen/analysis/basic.py +38 -0
  10. morphogen/analysis/cells.py +54 -0
  11. morphogen/analysis/connectivity.py +156 -0
  12. morphogen/analysis/correlation.py +195 -0
  13. morphogen/analysis/covariance.py +80 -0
  14. morphogen/analysis/fractal.py +54 -0
  15. morphogen/analysis/measures.py +188 -0
  16. morphogen/analysis/morphology.py +265 -0
  17. morphogen/analysis/particles.py +160 -0
  18. morphogen/analysis/percolation.py +2034 -0
  19. morphogen/analysis/power_laws.py +143 -0
  20. morphogen/analysis/random_sets.py +351 -0
  21. morphogen/analysis/stereology.py +289 -0
  22. morphogen/analysis/surface.py +107 -0
  23. morphogen/analysis/topology.py +92 -0
  24. morphogen/automata/__init__.py +74 -0
  25. morphogen/automata/engine.py +211 -0
  26. morphogen/automata/growth.py +686 -0
  27. morphogen/automata/lattice.py +143 -0
  28. morphogen/automata/reaction.py +255 -0
  29. morphogen/automata/rules.py +353 -0
  30. morphogen/automata/tilings.py +1715 -0
  31. morphogen/cli.py +3526 -0
  32. morphogen/config.py +2167 -0
  33. morphogen/contact/__init__.py +113 -0
  34. morphogen/contact/experiments.py +368 -0
  35. morphogen/contact/hertz.py +104 -0
  36. morphogen/contact/kernels.py +827 -0
  37. morphogen/contact/periodic.py +278 -0
  38. morphogen/contact/problem.py +578 -0
  39. morphogen/contact/surfaces.py +310 -0
  40. morphogen/coupling/__init__.py +43 -0
  41. morphogen/coupling/ageing.py +143 -0
  42. morphogen/coupling/diffusion.py +226 -0
  43. morphogen/coupling/fenicsx.py +484 -0
  44. morphogen/coupling/oxidation.py +447 -0
  45. morphogen/coupling/plates.py +247 -0
  46. morphogen/design/__init__.py +51 -0
  47. morphogen/design/csp.py +616 -0
  48. morphogen/design/frames.py +277 -0
  49. morphogen/design/search.py +287 -0
  50. morphogen/design/tiles.py +336 -0
  51. morphogen/distributions.py +312 -0
  52. morphogen/domain.py +203 -0
  53. morphogen/dynamics/__init__.py +179 -0
  54. morphogen/dynamics/model.py +638 -0
  55. morphogen/dynamics/openradioss.py +643 -0
  56. morphogen/dynamics/results.py +515 -0
  57. morphogen/fracture/__init__.py +170 -0
  58. morphogen/fracture/bulk.py +349 -0
  59. morphogen/fracture/cohesive.py +1614 -0
  60. morphogen/fracture/ductile.py +557 -0
  61. morphogen/fracture/lefm.py +1168 -0
  62. morphogen/fracture/mixed.py +1178 -0
  63. morphogen/fracture/periodic.py +733 -0
  64. morphogen/fracture/phasefield.py +714 -0
  65. morphogen/fracture/phasefield_finite.py +368 -0
  66. morphogen/fracture/surface.py +572 -0
  67. morphogen/fracture/toughness.py +566 -0
  68. morphogen/gpu.py +108 -0
  69. morphogen/gui/__init__.py +8 -0
  70. morphogen/gui/api.py +1927 -0
  71. morphogen/gui/desktop.py +387 -0
  72. morphogen/gui/icon.png +0 -0
  73. morphogen/gui/index.html +1909 -0
  74. morphogen/gui/server.py +229 -0
  75. morphogen/gui/tools/__init__.py +629 -0
  76. morphogen/gui/tools/compare.py +149 -0
  77. morphogen/gui/tools/contact.py +391 -0
  78. morphogen/gui/tools/couplings.py +1085 -0
  79. morphogen/gui/tools/crackfront.py +245 -0
  80. morphogen/gui/tools/design.py +224 -0
  81. morphogen/gui/tools/dynamics.py +824 -0
  82. morphogen/gui/tools/fracture.py +2586 -0
  83. morphogen/gui/tools/interop.py +1654 -0
  84. morphogen/gui/tools/learning.py +595 -0
  85. morphogen/gui/tools/mechanics.py +3881 -0
  86. morphogen/gui/tools/nonlocal_damage.py +1321 -0
  87. morphogen/gui/tools/phasefield.py +215 -0
  88. morphogen/gui/tools/physics.py +597 -0
  89. morphogen/gui/tools/stability.py +1756 -0
  90. morphogen/gui/tools/statistics.py +1408 -0
  91. morphogen/gui/viewer.js +1100 -0
  92. morphogen/homogenization/__init__.py +210 -0
  93. morphogen/homogenization/acoustics.py +566 -0
  94. morphogen/homogenization/amg.py +1005 -0
  95. morphogen/homogenization/apparent.py +1046 -0
  96. morphogen/homogenization/behaviours.cu +2285 -0
  97. morphogen/homogenization/behaviours.py +944 -0
  98. morphogen/homogenization/beremin.py +263 -0
  99. morphogen/homogenization/bifurcation.py +1085 -0
  100. morphogen/homogenization/bloch.py +507 -0
  101. morphogen/homogenization/bounds.py +226 -0
  102. morphogen/homogenization/core.py +458 -0
  103. morphogen/homogenization/coupled.py +1135 -0
  104. morphogen/homogenization/crystal.py +2967 -0
  105. morphogen/homogenization/dilatation.py +454 -0
  106. morphogen/homogenization/elements.py +157 -0
  107. morphogen/homogenization/fatigue.py +768 -0
  108. morphogen/homogenization/fe.py +1739 -0
  109. morphogen/homogenization/fenicsx.py +307 -0
  110. morphogen/homogenization/fft.py +499 -0
  111. morphogen/homogenization/fft_nonlinear.py +391 -0
  112. morphogen/homogenization/finite.py +613 -0
  113. morphogen/homogenization/flow.py +361 -0
  114. morphogen/homogenization/frames.py +1125 -0
  115. morphogen/homogenization/gpu.py +1241 -0
  116. morphogen/homogenization/harmonic.py +427 -0
  117. morphogen/homogenization/identification.py +579 -0
  118. morphogen/homogenization/kernels.py +760 -0
  119. morphogen/homogenization/laws.py +2061 -0
  120. morphogen/homogenization/materials.py +1080 -0
  121. morphogen/homogenization/mfront.py +589 -0
  122. morphogen/homogenization/networks.py +880 -0
  123. morphogen/homogenization/nonlinear.py +2612 -0
  124. morphogen/homogenization/ntfa.py +577 -0
  125. morphogen/homogenization/paths.py +476 -0
  126. morphogen/homogenization/photonic.py +467 -0
  127. morphogen/homogenization/poroelastic.py +212 -0
  128. morphogen/homogenization/porous.py +1120 -0
  129. morphogen/homogenization/postprocess.py +290 -0
  130. morphogen/homogenization/solvers.py +1140 -0
  131. morphogen/homogenization/tensors.py +240 -0
  132. morphogen/homogenization/voxel_fe.py +457 -0
  133. morphogen/homogenization/xfem.py +1016 -0
  134. morphogen/homogenization/zmat.py +1258 -0
  135. morphogen/iga/__init__.py +48 -0
  136. morphogen/iga/analysis.py +508 -0
  137. morphogen/iga/basis.py +214 -0
  138. morphogen/iga/geometry.py +501 -0
  139. morphogen/iga/homogenization.py +219 -0
  140. morphogen/iga/optimization.py +700 -0
  141. morphogen/iga/shapes.py +331 -0
  142. morphogen/image.py +128 -0
  143. morphogen/io/__init__.py +246 -0
  144. morphogen/io/amitex.py +741 -0
  145. morphogen/io/ebsd.py +881 -0
  146. morphogen/io/export.py +196 -0
  147. morphogen/io/geometry.py +158 -0
  148. morphogen/io/medit.py +147 -0
  149. morphogen/io/meshes.py +844 -0
  150. morphogen/io/metaimage.py +97 -0
  151. morphogen/io/mfront.py +1104 -0
  152. morphogen/io/native.py +57 -0
  153. morphogen/io/radioss.py +764 -0
  154. morphogen/io/solvers.py +371 -0
  155. morphogen/io/tables.py +278 -0
  156. morphogen/io/tiff.py +66 -0
  157. morphogen/io/vtk.py +701 -0
  158. morphogen/io/xdmf.py +200 -0
  159. morphogen/kernels/__init__.py +5 -0
  160. morphogen/kernels/annealing.py +192 -0
  161. morphogen/kernels/cells.py +69 -0
  162. morphogen/kernels/collective.py +87 -0
  163. morphogen/kernels/force_biased.py +595 -0
  164. morphogen/kernels/implicit.py +145 -0
  165. morphogen/kernels/leaves.py +132 -0
  166. morphogen/kernels/packing.py +304 -0
  167. morphogen/kernels/raster.py +279 -0
  168. morphogen/kernels/rsa.py +371 -0
  169. morphogen/kernels/union.py +135 -0
  170. morphogen/kernels/watershed.py +190 -0
  171. morphogen/laser/__init__.py +234 -0
  172. morphogen/laser/architectures.py +375 -0
  173. morphogen/laser/bending.py +216 -0
  174. morphogen/laser/cells.py +1694 -0
  175. morphogen/laser/design.py +940 -0
  176. morphogen/laser/figures.py +227 -0
  177. morphogen/laser/heat.py +804 -0
  178. morphogen/laser/materials.py +691 -0
  179. morphogen/laser/mechanics.py +1670 -0
  180. morphogen/laser/metallurgy.py +615 -0
  181. morphogen/laser/patterns.py +828 -0
  182. morphogen/laser/periodic.py +392 -0
  183. morphogen/laser/process.py +362 -0
  184. morphogen/laser/run.py +534 -0
  185. morphogen/laser/solid.py +216 -0
  186. morphogen/laser/specimen.py +200 -0
  187. morphogen/laser/structures.py +708 -0
  188. morphogen/learning/__init__.py +81 -0
  189. morphogen/learning/behaviour.py +398 -0
  190. morphogen/learning/data.py +328 -0
  191. morphogen/learning/learned.cpp +668 -0
  192. morphogen/learning/logarithmic.py +202 -0
  193. morphogen/learning/mfront.py +409 -0
  194. morphogen/learning/networks.py +767 -0
  195. morphogen/learning/run.py +212 -0
  196. morphogen/learning/standard.py +814 -0
  197. morphogen/learning/training.py +235 -0
  198. morphogen/mesh/__init__.py +29 -0
  199. morphogen/mesh/conforming.py +1423 -0
  200. morphogen/mesh/curved.py +600 -0
  201. morphogen/mesh/exact.py +1717 -0
  202. morphogen/mesh/octree.py +350 -0
  203. morphogen/mesh/polycrystal.py +1041 -0
  204. morphogen/mesh/polyhedra.py +677 -0
  205. morphogen/mesh/regularize.py +570 -0
  206. morphogen/mesh/surface.py +97 -0
  207. morphogen/mesh/tetra.py +512 -0
  208. morphogen/mesh/voxel.py +124 -0
  209. morphogen/micromorphic/__init__.py +31 -0
  210. morphogen/micromorphic/damage.py +359 -0
  211. morphogen/micromorphic/ductile.py +534 -0
  212. morphogen/micromorphic/finite.py +220 -0
  213. morphogen/micromorphic/microfoam.py +787 -0
  214. morphogen/micromorphic/space.py +341 -0
  215. morphogen/models/__init__.py +195 -0
  216. morphogen/models/affine.py +384 -0
  217. morphogen/models/automata.py +592 -0
  218. morphogen/models/base.py +500 -0
  219. morphogen/models/boolean.py +310 -0
  220. morphogen/models/bouligand.py +331 -0
  221. morphogen/models/branching.py +241 -0
  222. morphogen/models/combination.py +430 -0
  223. morphogen/models/deadleaves.py +766 -0
  224. morphogen/models/design.py +289 -0
  225. morphogen/models/ebsd.py +206 -0
  226. morphogen/models/fibers.py +1476 -0
  227. morphogen/models/foam.py +594 -0
  228. morphogen/models/gaussian.py +314 -0
  229. morphogen/models/growth.py +459 -0
  230. morphogen/models/hardcore.py +317 -0
  231. morphogen/models/hierarchical.py +269 -0
  232. morphogen/models/honeycomb.py +749 -0
  233. morphogen/models/implicit.py +177 -0
  234. morphogen/models/laminate.py +470 -0
  235. morphogen/models/lattice.py +351 -0
  236. morphogen/models/lattice_field.py +345 -0
  237. morphogen/models/levelset_foam.py +563 -0
  238. morphogen/models/nacre.py +411 -0
  239. morphogen/models/nested.py +924 -0
  240. morphogen/models/osteons.py +374 -0
  241. morphogen/models/pieces.py +167 -0
  242. morphogen/models/planar.py +126 -0
  243. morphogen/models/reconstruction.py +203 -0
  244. morphogen/models/scale_rich.py +1409 -0
  245. morphogen/models/scale_rich_3d.py +1616 -0
  246. morphogen/models/tessellation.py +735 -0
  247. morphogen/models/tiling_field.py +302 -0
  248. morphogen/models/tpms.py +197 -0
  249. morphogen/models/transparent.py +406 -0
  250. morphogen/models/union.py +141 -0
  251. morphogen/optimization/__init__.py +43 -0
  252. morphogen/optimization/cell.py +295 -0
  253. morphogen/optimization/filters.py +115 -0
  254. morphogen/optimization/mma.py +226 -0
  255. morphogen/optimization/run.py +219 -0
  256. morphogen/optimization/topology.py +632 -0
  257. morphogen/orientations.py +568 -0
  258. morphogen/parallel.py +599 -0
  259. morphogen/pipeline.py +978 -0
  260. morphogen/primitives.py +188 -0
  261. morphogen/results.py +564 -0
  262. morphogen/rve/__init__.py +73 -0
  263. morphogen/rve/report.py +627 -0
  264. morphogen/rve/scaling.py +363 -0
  265. morphogen/rve/study.py +1054 -0
  266. morphogen/rve/windows.py +345 -0
  267. morphogen/seeding.py +51 -0
  268. morphogen/settings.py +118 -0
  269. morphogen/stopping.py +48 -0
  270. morphogen/symmetry.py +384 -0
  271. morphogen/templates/activator_inhibitor.yaml +22 -0
  272. morphogen/templates/aggregation.yaml +23 -0
  273. morphogen/templates/boolean_cylinders.yaml +20 -0
  274. morphogen/templates/boolean_spheres.yaml +22 -0
  275. morphogen/templates/bouligand.yaml +28 -0
  276. morphogen/templates/cellular_automaton.yaml +25 -0
  277. morphogen/templates/coated_spheres.yaml +26 -0
  278. morphogen/templates/contact_fibers.yaml +27 -0
  279. morphogen/templates/cox_nanocomposite.yaml +22 -0
  280. morphogen/templates/cross_linked_fibers.yaml +26 -0
  281. morphogen/templates/curved_arcs.yaml +28 -0
  282. morphogen/templates/curved_fibers.yaml +24 -0
  283. morphogen/templates/dead_leaves.yaml +22 -0
  284. morphogen/templates/delaunay_network.yaml +22 -0
  285. morphogen/templates/dense_packing.yaml +22 -0
  286. morphogen/templates/diffusion.yaml +33 -0
  287. morphogen/templates/ebsd.yaml +34 -0
  288. morphogen/templates/ebsd_map.ctf +3087 -0
  289. morphogen/templates/fracture_composite.yaml +42 -0
  290. morphogen/templates/fracture_rubber.yaml +47 -0
  291. morphogen/templates/gaussian_excursion.yaml +17 -0
  292. morphogen/templates/graded_lattice.yaml +24 -0
  293. morphogen/templates/hardcore_fibers.yaml +22 -0
  294. morphogen/templates/hardcore_spheres.yaml +22 -0
  295. morphogen/templates/hierarchical_lattice.yaml +22 -0
  296. morphogen/templates/homogenization_acoustic_foam.yaml +36 -0
  297. morphogen/templates/homogenization_beremin.yaml +50 -0
  298. morphogen/templates/homogenization_cleavage.yaml +51 -0
  299. morphogen/templates/homogenization_cleavage_band.yaml +55 -0
  300. morphogen/templates/homogenization_contact.yaml +43 -0
  301. morphogen/templates/homogenization_crack_closure.yaml +49 -0
  302. morphogen/templates/homogenization_crystal_plasticity.yaml +50 -0
  303. morphogen/templates/homogenization_crystal_plasticity_fft.yaml +52 -0
  304. morphogen/templates/homogenization_crystallization.yaml +30 -0
  305. morphogen/templates/homogenization_debonding.yaml +43 -0
  306. morphogen/templates/homogenization_detwinning.yaml +58 -0
  307. morphogen/templates/homogenization_ductile_damage.yaml +47 -0
  308. morphogen/templates/homogenization_fatigue.yaml +40 -0
  309. morphogen/templates/homogenization_grain_fracture.yaml +56 -0
  310. morphogen/templates/homogenization_gyroid.yaml +30 -0
  311. morphogen/templates/homogenization_intergranular.yaml +43 -0
  312. morphogen/templates/homogenization_interphase.yaml +42 -0
  313. morphogen/templates/homogenization_mixed_loading.yaml +33 -0
  314. morphogen/templates/homogenization_ntfa.yaml +56 -0
  315. morphogen/templates/homogenization_piezoelectric.yaml +27 -0
  316. morphogen/templates/homogenization_polycrystal.yaml +30 -0
  317. morphogen/templates/homogenization_polycrystal_inclusions.yaml +30 -0
  318. morphogen/templates/homogenization_poroelastic.yaml +26 -0
  319. morphogen/templates/homogenization_rubber.yaml +40 -0
  320. morphogen/templates/homogenization_slip_cleavage.yaml +50 -0
  321. morphogen/templates/homogenization_spheres.yaml +31 -0
  322. morphogen/templates/homogenization_transport.yaml +29 -0
  323. morphogen/templates/homogenization_twinning.yaml +54 -0
  324. morphogen/templates/homogenization_viscoelastic.yaml +34 -0
  325. morphogen/templates/homogenization_viscoplastic.yaml +42 -0
  326. morphogen/templates/homogenization_voronoi.yaml +26 -0
  327. morphogen/templates/homogenization_xfem.yaml +23 -0
  328. morphogen/templates/hyperuniform_cells.yaml +24 -0
  329. morphogen/templates/laguerre.yaml +18 -0
  330. morphogen/templates/laser_bending.yaml +35 -0
  331. morphogen/templates/laser_cells.yaml +38 -0
  332. morphogen/templates/laser_corrugated.yaml +36 -0
  333. morphogen/templates/level_set_foam.yaml +29 -0
  334. morphogen/templates/menger_sponge.yaml +17 -0
  335. morphogen/templates/nacre.yaml +25 -0
  336. morphogen/templates/nucleation_growth.yaml +25 -0
  337. morphogen/templates/optimize_auxetic.yaml +29 -0
  338. morphogen/templates/optimize_auxetic_3d.yaml +27 -0
  339. morphogen/templates/optimize_bulk.yaml +23 -0
  340. morphogen/templates/optimize_conductivity.yaml +20 -0
  341. morphogen/templates/osteons.yaml +28 -0
  342. morphogen/templates/penetrable_spheres.yaml +21 -0
  343. morphogen/templates/poisson_fibers.yaml +21 -0
  344. morphogen/templates/random_laminate.yaml +26 -0
  345. morphogen/templates/random_lattice.yaml +27 -0
  346. morphogen/templates/random_walk_fibers.yaml +26 -0
  347. morphogen/templates/reaction_diffusion.yaml +22 -0
  348. morphogen/templates/reconstruction.yaml +22 -0
  349. morphogen/templates/rve_cellular_automaton.yaml +23 -0
  350. morphogen/templates/rve_crystal_plasticity_fft.yaml +51 -0
  351. morphogen/templates/rve_multiphysics.yaml +43 -0
  352. morphogen/templates/rve_poisson_fibers.yaml +22 -0
  353. morphogen/templates/rve_poisson_fibers_fe.yaml +33 -0
  354. morphogen/templates/rve_voronoi_windows.yaml +20 -0
  355. morphogen/templates/scale_rich_network.yaml +29 -0
  356. morphogen/templates/scale_rich_plates.yaml +30 -0
  357. morphogen/templates/sequential_dead_leaves.yaml +25 -0
  358. morphogen/templates/strut_lattice.yaml +21 -0
  359. morphogen/templates/tile_assembly.yaml +28 -0
  360. morphogen/templates/tpms.yaml +19 -0
  361. morphogen/templates/trabecular_bone.yaml +29 -0
  362. morphogen/templates/transparent_dead_leaves.yaml +23 -0
  363. morphogen/templates/vascular_tree.yaml +23 -0
  364. morphogen/templates/voronoi.yaml +20 -0
  365. morphogen/templates/wood.yaml +34 -0
  366. morphogen/templates/workflow.yaml +56 -0
  367. morphogen/texture.py +665 -0
  368. morphogen/theory.py +162 -0
  369. morphogen/viz/__init__.py +12 -0
  370. morphogen/viz/export.py +244 -0
  371. morphogen/viz/figures.py +707 -0
  372. morphogen/viz/png.py +148 -0
  373. morphogen/viz/sections.py +696 -0
  374. morphogen/viz/surfaces.py +1352 -0
  375. morphogen/viz/video.py +904 -0
  376. morphogen/viz/workflow.py +488 -0
  377. morphogen-1.0.0.dist-info/METADATA +2316 -0
  378. morphogen-1.0.0.dist-info/RECORD +381 -0
  379. morphogen-1.0.0.dist-info/WHEEL +4 -0
  380. morphogen-1.0.0.dist-info/entry_points.txt +5 -0
  381. morphogen-1.0.0.dist-info/licenses/LICENSE +674 -0
@@ -0,0 +1,629 @@
1
+ """The tools of the interface: each a form of fields and a function run on items of the
2
+ workspace of the session, grouped in tabs (statistics, mechanics, fracture, stability,
3
+ ...) and, in a tab, under the headings of its menu (:func:`menus`). The page builds the
4
+ tabs, their menus and the forms from :func:`catalog` and runs a tool as a job
5
+ (:class:`ToolJob`) whose progress it follows; a tool returns values, tables, figures,
6
+ videos and files, and may add morphologies or results to the workspace, from which any
7
+ other tab takes them in turn.
8
+
9
+ A tool is a function ``run(params, ctx)`` registered by :func:`tool` with its fields
10
+ (:class:`Field`): ``params`` are the values of the form, converted and checked (an item
11
+ field gives the item of the workspace, a dictionary with its microstructure under
12
+ ``"micro"``), and ``ctx`` (:class:`Context`) writes the files of the result in a folder of
13
+ its own and reports the progress."""
14
+
15
+ from __future__ import annotations
16
+
17
+ import csv
18
+ import threading
19
+ import time
20
+ import warnings
21
+ from collections.abc import Callable
22
+ from dataclasses import dataclass, field
23
+ from pathlib import Path
24
+ from typing import Any
25
+
26
+ import numpy as np
27
+
28
+ from morphogen.stopping import Stopped, checkpoint, stoppable
29
+
30
+ #: The tabs of the tools: id -> title, documentation and rank among the tabs of the page
31
+ TABS: dict[str, dict] = {}
32
+ #: The tools by name
33
+ TOOLS: dict[str, Tool] = {}
34
+ #: The kinds of fields of the forms
35
+ KINDS = (
36
+ "float",
37
+ "int",
38
+ "str",
39
+ "bool",
40
+ "choice",
41
+ "choices",
42
+ "floats",
43
+ "ints",
44
+ "json",
45
+ "text",
46
+ "item",
47
+ "items",
48
+ "materials",
49
+ )
50
+
51
+
52
+ #: The sections of the menus of the page: create a morphology, characterize it, simulate
53
+ #: it, export and compare the results
54
+ SECTIONS = ("create", "characterize", "simulate", "share")
55
+ #: The section of the tabs that do not give theirs (the others: simulate)
56
+ SECTION_OF = {"statistics": "characterize", "design": "create", "interop": "share"}
57
+
58
+
59
+ def tab(name: str, title: str, doc: str, order: int, section: str | None = None) -> None:
60
+ """Declare a tab of tools: its ``order`` places it among the tabs of its ``section``
61
+ of the menus (:data:`SECTIONS`; by default :data:`SECTION_OF`, else ``simulate``)."""
62
+ section = section or SECTION_OF.get(name, "simulate")
63
+ if section not in SECTIONS:
64
+ raise ValueError(f"tab {name}: section among {', '.join(SECTIONS)}")
65
+ TABS[name] = {"name": name, "title": title, "doc": doc, "order": int(order), "section": section}
66
+
67
+
68
+ @dataclass(frozen=True)
69
+ class Field:
70
+ """A field of the form of a tool: ``kind`` among :data:`KINDS` (``choice`` and
71
+ ``choices`` among ``choices``; ``item`` an item of the workspace of the ``items``
72
+ kinds, ``none`` the choice of none when it is optional, ``items`` several of them;
73
+ ``materials`` the elastic constants of the phases of the item of the field ``of``, its
74
+ ``default`` the ``young`` and ``poisson`` that the editor gives the phases that are not
75
+ voids;
76
+ ``needs``: the traits the item must have, see :data:`morphogen.gui.api.TRAITS`), shown
77
+ only when the fields of ``when`` have one of the values given; ``group`` the box of the
78
+ form that holds it (folded until opened if ``fold``), set by the ``groups`` of
79
+ :func:`tool`; ``browse``: ``folder`` or ``file`` for a path, which the desktop
80
+ application (:mod:`morphogen.gui.desktop`) lets choose in a dialog of the system."""
81
+
82
+ name: str
83
+ kind: str = "float"
84
+ default: Any = None
85
+ label: str = ""
86
+ doc: str = ""
87
+ unit: str = ""
88
+ choices: tuple = ()
89
+ items: tuple = ("morphology",)
90
+ of: str = ""
91
+ when: dict | None = None
92
+ required: bool = False
93
+ needs: tuple = ()
94
+ group: str = ""
95
+ fold: bool = False
96
+ none: str = ""
97
+ browse: str = ""
98
+
99
+ def __post_init__(self):
100
+ if self.kind not in KINDS:
101
+ raise ValueError(f"field {self.name}: kind among {', '.join(KINDS)}")
102
+ if self.browse not in ("", "folder", "file"):
103
+ raise ValueError(f"field {self.name}: browse is folder or file")
104
+
105
+ def to_dict(self) -> dict:
106
+ out = {
107
+ "name": self.name,
108
+ "kind": self.kind,
109
+ "default": self.default,
110
+ "label": self.label or self.name.replace("_", " "),
111
+ "doc": self.doc,
112
+ "unit": self.unit,
113
+ "required": self.required,
114
+ }
115
+ if self.choices:
116
+ out["choices"] = [list(c) if isinstance(c, tuple) else [c, c] for c in self.choices]
117
+ if self.kind in ("item", "items"):
118
+ out["items"] = list(self.items)
119
+ out["needs"] = list(self.needs)
120
+ if self.none:
121
+ out["none"] = self.none
122
+ if self.of:
123
+ out["of"] = self.of
124
+ if self.when:
125
+ out["when"] = {k: v if isinstance(v, list) else [v] for k, v in self.when.items()}
126
+ if self.group:
127
+ out["group"] = self.group
128
+ out["fold"] = self.fold
129
+ if self.browse:
130
+ out["browse"] = self.browse
131
+ return out
132
+
133
+ def _choice_values(self) -> list:
134
+ return [c[0] if isinstance(c, tuple) else c for c in self.choices]
135
+
136
+ def parse(self, value, session):
137
+ """The value of the form, converted and checked."""
138
+ if value in (None, "") or (isinstance(value, list) and not value and self.required):
139
+ if self.required:
140
+ raise ValueError(f"{self.label or self.name}: required")
141
+ # the default of a field of materials is the material of the editor, not a value
142
+ value = self.default if self.kind != "materials" else None
143
+ if value is None:
144
+ return None
145
+ kind = self.kind
146
+ name = self.label or self.name
147
+ try:
148
+ if kind == "float":
149
+ return float(value)
150
+ if kind == "int":
151
+ return int(value)
152
+ if kind == "bool":
153
+ return bool(value) if not isinstance(value, str) else value.lower() == "true"
154
+ if kind in ("floats", "ints"):
155
+ cast = float if kind == "floats" else int
156
+ if isinstance(value, str):
157
+ value = [v for v in value.replace(";", ",").replace(" ", ",").split(",") if v]
158
+ values = [cast(v) for v in np.atleast_1d(value)]
159
+ return values
160
+ except (TypeError, ValueError):
161
+ raise ValueError(f"{name}: expected {kind}, got {value!r}") from None
162
+ if kind == "choice":
163
+ if value not in self._choice_values():
164
+ raise ValueError(f"{name}: one of {', '.join(map(str, self._choice_values()))}")
165
+ return value
166
+ if kind == "choices":
167
+ values = [value] if isinstance(value, str) else list(value)
168
+ unknown = [v for v in values if v not in self._choice_values()]
169
+ if unknown:
170
+ raise ValueError(f"{name}: among {', '.join(map(str, self._choice_values()))}")
171
+ return values
172
+ if kind == "items": # several items: their keys, as a list or separated by commas
173
+ keys = [value] if isinstance(value, str) else list(value)
174
+ keys = [k.strip() for v in keys for k in str(v).split(",") if k.strip()]
175
+ if not keys and self.required:
176
+ raise ValueError(f"{name}: required")
177
+ item = Field(self.name, "item", items=self.items, needs=self.needs, label=name)
178
+ return [item.parse(k, session) for k in dict.fromkeys(keys)]
179
+ if kind == "item":
180
+ if session is None:
181
+ raise ValueError(f"{name}: the workspace of a session is needed")
182
+ from morphogen.gui.api import TRAITS, item_traits
183
+
184
+ item = session.item(value, self.items)
185
+ missing = [TRAITS[n] for n in self.needs if n not in item_traits(item)]
186
+ if missing:
187
+ raise ValueError(f"{name}: {item['title']} is not {' and '.join(missing)}")
188
+ if item["kind"] == "behaviour": # its material, the files it names by their paths
189
+ from morphogen.gui.api import behaviour_material
190
+
191
+ item = {**item, "material": behaviour_material(item, session.root)}
192
+ return item
193
+ if kind == "json":
194
+ import json
195
+
196
+ return json.loads(value) if isinstance(value, str) else value
197
+ if kind == "materials":
198
+ from morphogen.gui.api import _materials
199
+
200
+ return _materials({"materials": value})
201
+ return str(value)
202
+
203
+
204
+ @dataclass
205
+ class Tool:
206
+ """A tool of the interface (see the module)."""
207
+
208
+ name: str
209
+ tab: str
210
+ title: str
211
+ doc: str
212
+ fields: tuple[Field, ...]
213
+ run: Callable
214
+ order: int = 0
215
+ menu: str = ""
216
+
217
+ def to_dict(self) -> dict:
218
+ return {
219
+ "name": self.name,
220
+ "tab": self.tab,
221
+ "title": self.title,
222
+ "doc": self.doc,
223
+ "menu": self.menu,
224
+ "fields": [f.to_dict() for f in self.fields],
225
+ }
226
+
227
+ def parse(self, params: dict, session) -> dict:
228
+ """The values of the form, converted and checked (hidden fields left out)."""
229
+ params = dict(params or {})
230
+ out: dict = {}
231
+ for f in self.fields: # in order: the conditions refer to earlier fields
232
+ if f.when and not all(
233
+ out.get(k) in (v if isinstance(v, list) else [v]) for k, v in f.when.items()
234
+ ):
235
+ out[f.name] = None
236
+ continue
237
+ out[f.name] = f.parse(params.get(f.name), session)
238
+ return out
239
+
240
+
241
+ def tool(
242
+ name: str,
243
+ tab: str,
244
+ title: str,
245
+ doc: str,
246
+ fields=(),
247
+ order: int = 0,
248
+ groups=(),
249
+ menu: str = "",
250
+ ):
251
+ """Register the function ``run(params, ctx)`` of a tool (see the module). ``menu``: the
252
+ heading under which the menu of its tab lists it (:func:`menus`), with the tools that
253
+ do the same kind of work; ``order`` ranks it among them. ``groups``: the boxes of its
254
+ form, ``(title, first field)`` or ``(title, first field, True)`` for a box folded until
255
+ opened (details seldom changed), each from its first field to the first field of the
256
+ next; the fields before the first box stand above them."""
257
+
258
+ def wrap(fn: Callable) -> Callable:
259
+ known = TOOLS.get(name)
260
+ if known is not None and known.run.__module__ != fn.__module__:
261
+ raise ValueError(f"tool {name}: already the name of a tool of {known.run.__module__}")
262
+ boxed = _grouped(name, tuple(fields), groups)
263
+ TOOLS[name] = Tool(name, tab, title, doc, boxed, fn, order, str(menu))
264
+ return fn
265
+
266
+ return wrap
267
+
268
+
269
+ def _grouped(name: str, fields: tuple[Field, ...], groups) -> tuple[Field, ...]:
270
+ """The ``fields`` in the boxes ``groups`` of :func:`tool`."""
271
+ from dataclasses import replace
272
+
273
+ starts = {g[1]: (g[0], bool(g[2]) if len(g) > 2 else False) for g in groups}
274
+ unknown = set(starts) - {f.name for f in fields}
275
+ if unknown:
276
+ raise ValueError(f"tool {name}: no field {', '.join(sorted(unknown))} to start a group")
277
+ out, box = [], ("", False)
278
+ for f in fields:
279
+ box = starts.get(f.name, box)
280
+ out.append(replace(f, group=box[0], fold=box[1]) if box[0] else f)
281
+ return tuple(out)
282
+
283
+
284
+ def _load() -> None:
285
+ """Import the modules of the tools, every module of this package (they register
286
+ themselves); a module that cannot be imported (a missing optional dependency) is
287
+ left out with a warning."""
288
+ import importlib
289
+ import pkgutil
290
+
291
+ for info in pkgutil.iter_modules(__path__):
292
+ name = f"{__name__}.{info.name}"
293
+ try:
294
+ importlib.import_module(name)
295
+ except ImportError as exc: # pragma: no cover - optional dependencies
296
+ warnings.warn(f"tools of {info.name} unavailable: {exc}", stacklevel=2)
297
+
298
+
299
+ def menus(tab: str) -> list[tuple[str, list[Tool]]]:
300
+ """The menu of the tools of a tab: its headings (the ``menu`` of :func:`tool`; none for
301
+ the tools that give none) in the order of their first tool, each with its tools in
302
+ their order, so that the tools that do the same kind of work stand together."""
303
+ _load()
304
+ tools = sorted((t for t in TOOLS.values() if t.tab == tab), key=lambda t: t.order)
305
+ return [(h, [t for t in tools if t.menu == h]) for h in dict.fromkeys(t.menu for t in tools)]
306
+
307
+
308
+ def catalog() -> dict:
309
+ """The tabs (by their order) and the tools of the interface, those of a tab as its
310
+ menu lists them (:func:`menus`: each with the heading ``menu`` it stands under)."""
311
+ _load()
312
+ tabs = sorted(TABS.values(), key=lambda t: t["order"])
313
+ tools = [t for tab in tabs for _, listed in menus(tab["name"]) for t in listed]
314
+ tools += sorted((t for t in TOOLS.values() if t.tab not in TABS), key=lambda t: t.order)
315
+ return {"tabs": tabs, "tools": [t.to_dict() for t in tools]}
316
+
317
+
318
+ class Context:
319
+ """What the run of a tool sees: the ``session`` (its workspace), the folder and key of
320
+ its result, and the progress it reports (:meth:`progress`)."""
321
+
322
+ def __init__(self, session, key: str, folder: Path, job: ToolJob | None = None):
323
+ self.session = session
324
+ self.key = key
325
+ self.folder = Path(folder)
326
+ self.job = job
327
+ self.figures: list[dict] = []
328
+ self.videos: list[dict] = []
329
+ self.tables: list[dict] = []
330
+ self.items: list[dict] = []
331
+
332
+ def progress(self, fraction: float, message: str = "") -> None:
333
+ """Report the progress; a checkpoint of :mod:`morphogen.stopping` (in the thread
334
+ of the job: the tool stops there when asked to)."""
335
+ if self.job is not None:
336
+ self.job.report(fraction, message)
337
+ checkpoint()
338
+
339
+ def path(self, name: str) -> Path:
340
+ return self.folder / name
341
+
342
+ def url(self, name: str) -> str:
343
+ return f"/files/{self.key}/{name}"
344
+
345
+ def figure(self, figure, name: str, title: str = "") -> dict:
346
+ """A figure of the result: a matplotlib figure (also as .svg) or an RGB array."""
347
+ path = self.folder / f"{name}.png"
348
+ if isinstance(figure, np.ndarray):
349
+ from morphogen.viz.png import encode_png
350
+
351
+ path.write_bytes(encode_png(figure))
352
+ else:
353
+ from morphogen.viz.export import save_figure
354
+
355
+ save_figure(figure, path, dpi=130)
356
+ save_figure(figure, self.folder / f"{name}.svg")
357
+ out = {"title": title or name.replace("_", " "), "url": self.url(path.name)}
358
+ self.figures.append(out)
359
+ return out
360
+
361
+ def video(self, frames, name: str, title: str = "", fps: float = 18, mode: str = "bounce"):
362
+ from morphogen.gui.api import _video_format
363
+ from morphogen.viz.video import write_video
364
+
365
+ fmt = _video_format()
366
+ path = self.folder / f"{name}.{fmt}"
367
+ write_video(frames, path, fps=fps, mode=mode)
368
+ out = {"title": title or name.replace("_", " "), "url": self.url(path.name), "format": fmt}
369
+ self.videos.append(out)
370
+ return out
371
+
372
+ def table(self, rows: list[dict], name: str, title: str = "", shown: int = 40) -> dict:
373
+ """A table of the result, written as .csv (its first ``shown`` rows in the page)."""
374
+ columns: list[str] = []
375
+ for row in rows:
376
+ columns += [k for k in row if k not in columns]
377
+ path = self.folder / f"{name}.csv"
378
+ with path.open("w", encoding="utf-8", newline="") as f:
379
+ writer = csv.DictWriter(f, columns)
380
+ writer.writeheader()
381
+ writer.writerows(rows)
382
+ out = {
383
+ "title": title or name.replace("_", " "),
384
+ "columns": columns,
385
+ "rows": [[_cell(row.get(c)) for c in columns] for row in rows[:shown]],
386
+ "count": len(rows),
387
+ "url": self.url(path.name),
388
+ }
389
+ self.tables.append(out)
390
+ return out
391
+
392
+ def add(self, kind: str, title: str, **data) -> dict:
393
+ """Add a morphology or a result to the workspace (in a folder of its own)."""
394
+ key, _ = self.session.folder()
395
+ item = self.session.add(key, kind, title, **data)
396
+ public = self.session.public(item)
397
+ self.items.append(public)
398
+ return public
399
+
400
+
401
+ #: The notation of the tables of stiffnesses and compliances, in space and in the plane
402
+ VOIGT_NOTE = "Voigt 11, 22, 33, 23, 31, 12, engineering shears (TFEL, Abaqus: 12, 13, 23)"
403
+ PLANE_NOTE = "Voigt 11, 22, 12, engineering shear"
404
+
405
+
406
+ def matrix_rows(matrix) -> list[dict]:
407
+ """The rows of the table of a 6 x 6 matrix (3 x 3 in the plane) in morphoGen's Voigt
408
+ order: the component of each row, then a column per component."""
409
+ from morphogen.homogenization.postprocess import PLANE_ORDER, VOIGT_ORDER
410
+
411
+ m = np.asarray(matrix, dtype=float)
412
+ labels = PLANE_ORDER if m.shape == (3, 3) else VOIGT_ORDER
413
+ return [
414
+ {"": a, **{b: float(m[i, j]) for j, b in enumerate(labels)}} for i, a in enumerate(labels)
415
+ ]
416
+
417
+
418
+ def elastic_tables(
419
+ ctx,
420
+ stiffness,
421
+ of: str = "",
422
+ *,
423
+ names=("stiffness", "compliance"),
424
+ units=("", ""),
425
+ kind: str = "",
426
+ compliance=None,
427
+ ) -> np.ndarray:
428
+ """The tables of a stiffness ``C`` and of its ``compliance`` ``S = C^-1`` (computed when
429
+ not given) as .csv, named ``names``, titled by their ``kind`` (e.g. "apparent"), what
430
+ they are ``of``, their notation and their ``units`` (those of the moduli and their
431
+ inverse by default); returns ``S``."""
432
+ from morphogen.homogenization.postprocess import compliance as inverse
433
+
434
+ c = np.asarray(stiffness, dtype=float)
435
+ s = inverse(c) if compliance is None else np.asarray(compliance, dtype=float)
436
+ note = PLANE_NOTE if c.shape == (3, 3) else VOIGT_NOTE
437
+ of, kind = (f" {of}" if of else ""), (f"{kind} " if kind else "")
438
+ unit_c = units[0] or "units of the moduli"
439
+ unit_s = units[1] or "their inverse"
440
+ ctx.table(matrix_rows(c), names[0], f"{kind}stiffness C_ij{of}: {note}; {unit_c}")
441
+ ctx.table(
442
+ matrix_rows(s), names[1], f"{kind}compliance S_ij = C⁻¹{of}: the same notation; {unit_s}"
443
+ )
444
+ return s
445
+
446
+
447
+ def _cell(value):
448
+ if isinstance(value, (float, np.floating)):
449
+ return float(f"{float(value):.6g}") if np.isfinite(value) else None
450
+ if isinstance(value, (int, np.integer)):
451
+ return int(value)
452
+ return value if value is None or isinstance(value, (str, bool)) else str(value)
453
+
454
+
455
+ class ToolJob:
456
+ """A tool running in a thread, with its progress and result (see the module); stopped
457
+ (:meth:`stop`) at the next progress it reports or iteration of its solvers, it keeps
458
+ nothing in the workspace."""
459
+
460
+ def __init__(self, request: dict, session):
461
+ _load()
462
+ name = request.get("tool")
463
+ if name not in TOOLS:
464
+ raise ValueError(f"tool: one of {', '.join(sorted(TOOLS))}")
465
+ self.tool = TOOLS[name]
466
+ self.raw_params = dict(request.get("params") or {}) # as the form sent them
467
+ self.params = self.tool.parse(self.raw_params, session) # errors at once
468
+ self.session = session
469
+ self.key, self.folder = session.folder()
470
+ self.started = time.perf_counter()
471
+ self.state = "running"
472
+ self.fraction = 0.0
473
+ self.message = ""
474
+ self.result: dict | None = None
475
+ self.error: str | None = None
476
+ self._lock = threading.Lock()
477
+ self._stop = threading.Event()
478
+ self.thread = threading.Thread(target=self._run, daemon=True)
479
+
480
+ def start(self) -> ToolJob:
481
+ self.thread.start()
482
+ return self
483
+
484
+ def stop(self) -> None:
485
+ """Stop at the next checkpoint (:mod:`morphogen.stopping`)."""
486
+ self._stop.set()
487
+
488
+ def report(self, fraction: float, message: str = "") -> None:
489
+ with self._lock:
490
+ self.fraction = float(min(max(fraction, 0.0), 1.0))
491
+ self.message = str(message)
492
+
493
+ def _run(self):
494
+ from morphogen.gui.api import _files, shown_warnings
495
+
496
+ ctx = Context(self.session, self.key, self.folder, self)
497
+ try:
498
+ with warnings.catch_warnings(record=True) as caught, stoppable(self._stop):
499
+ warnings.simplefilter("always")
500
+ out = self.tool.run(self.params, ctx) or {}
501
+ if "archive" not in out:
502
+ archive = _archive(self.folder)
503
+ if archive is not None:
504
+ out["archive"] = ctx.url(archive.name)
505
+ result = {
506
+ "tool": self.tool.name,
507
+ "title": out.pop("title", self.tool.title),
508
+ "values": _finite_values(out.pop("values", {})),
509
+ "tables": ctx.tables + out.pop("tables", []),
510
+ "figures": ctx.figures + out.pop("figures", []),
511
+ "videos": ctx.videos + out.pop("videos", []),
512
+ "items": ctx.items + out.pop("items", []),
513
+ "text": out.pop("text", ""),
514
+ "files": _files(self.key, self.folder),
515
+ "time_s": round(time.perf_counter() - self.started, 2),
516
+ "warnings": shown_warnings(caught),
517
+ **out,
518
+ }
519
+ self._keep(result)
520
+ with self._lock:
521
+ self.result, self.state, self.fraction = result, "done", 1.0
522
+ except Stopped: # nothing kept: the items it made leave the workspace
523
+ for key in [self.key] + [i["key"] for i in ctx.items]:
524
+ if key in self.session.items:
525
+ self.session.remove(key)
526
+ with self._lock:
527
+ self.state = "stopped"
528
+ except Exception as exc: # reported to the page
529
+ with self._lock:
530
+ self.error, self.state = f"{type(exc).__name__}: {exc}", "error"
531
+
532
+ def _keep(self, result: dict) -> None:
533
+ """The run kept in the workspace as a result: its tool, the parameters of its form
534
+ (to fill it again) and its result (to show it again), titled by the items it took;
535
+ when the tool made its folder an item itself (the simulation of a loading path), the
536
+ run joins that item, which keeps its kind."""
537
+ took = []
538
+ for f in self.tool.fields:
539
+ if f.kind in ("item", "items"):
540
+ value = self.params.get(f.name)
541
+ values = value if isinstance(value, list) else [value]
542
+ took += [f"#{v['number']}" for v in values if isinstance(v, dict)]
543
+ title = self.tool.title + (f" ({', '.join(took)})" if took else "")
544
+ values = dict(list(result["values"].items())[:6])
545
+ # its mesh of fields, if any (cracks, damage, patterns): drawn by the 3D view
546
+ result.update(key=self.key, view3d=bool(meshes_of_result(self.folder)))
547
+ run = {"tool": self.tool.name, "tab": self.tool.tab, "params": self.raw_params,
548
+ "result": result} # fmt: skip
549
+ made = self.session.items.get(self.key)
550
+ if made is not None:
551
+ made.update(run)
552
+ return
553
+ self.session.add(self.key, "result", title, info=values, view3d=result["view3d"], **run)
554
+
555
+ def status(self) -> dict:
556
+ with self._lock:
557
+ out = {
558
+ "state": self.state,
559
+ "progress": self.fraction,
560
+ "message": self.message,
561
+ "elapsed_s": round(time.perf_counter() - self.started, 1),
562
+ }
563
+ if self.result is not None:
564
+ out["result"] = self.result
565
+ if self.error is not None:
566
+ out["error"] = self.error
567
+ return out
568
+
569
+
570
+ def meshes_of_result(folder: Path) -> list[Path]:
571
+ """The meshes of the fields of the result of a tool (.vtu files of tetrahedra with
572
+ their displacement: cracked bodies, damaged specimens, bifurcated patterns), the last
573
+ (that of the last step) last; the meshes alone (``*_tet.vtu``) and the cohesive
574
+ interfaces (``*_interfaces.vtu``, wedges) left out."""
575
+ return sorted(
576
+ p for p in Path(folder).glob("*.vtu") if not p.stem.endswith(("_tet", "_interfaces"))
577
+ )
578
+
579
+
580
+ def _archive(folder: Path) -> Path | None:
581
+ """An archive of every file of the result of a tool (subfolders kept), if any."""
582
+ import zipfile
583
+
584
+ files = [p for p in sorted(Path(folder).rglob("*")) if p.is_file() and p.suffix != ".zip"]
585
+ if not files:
586
+ return None
587
+ path = Path(folder) / "result.zip"
588
+ with zipfile.ZipFile(path, "w", zipfile.ZIP_DEFLATED) as archive:
589
+ for file in files:
590
+ archive.write(file, file.relative_to(folder).as_posix())
591
+ return path
592
+
593
+
594
+ def _finite_values(values: dict) -> dict:
595
+ out = {}
596
+ for k, v in (values or {}).items():
597
+ if isinstance(v, (int, float, np.integer, np.floating)) and not isinstance(v, bool):
598
+ if np.isfinite(v):
599
+ out[k] = float(v) if isinstance(v, (float, np.floating)) else int(v)
600
+ elif isinstance(v, (str, bool)):
601
+ out[k] = v
602
+ return out
603
+
604
+
605
+ @dataclass
606
+ class Watcher:
607
+ """Reports the progress of a run that writes one file per step (``pattern`` in
608
+ ``folder``, ``total`` of them) from a thread, until stopped."""
609
+
610
+ ctx: Context
611
+ folder: Path
612
+ pattern: str
613
+ total: int
614
+ message: str = ""
615
+ _stop: threading.Event = field(default_factory=threading.Event)
616
+
617
+ def __enter__(self) -> Watcher:
618
+ self._thread = threading.Thread(target=self._watch, daemon=True)
619
+ self._thread.start()
620
+ return self
621
+
622
+ def __exit__(self, *exc) -> None:
623
+ self._stop.set()
624
+ self._thread.join(timeout=2)
625
+
626
+ def _watch(self):
627
+ while not self._stop.wait(0.5):
628
+ done = len(list(Path(self.folder).glob(self.pattern)))
629
+ self.ctx.progress(done / max(self.total, 1), f"{self.message} {done} / {self.total}")