DynaRef 6.5.2__tar.gz → 6.5.3__tar.gz

{dynaref-6.5.2/src/DynaRef.egg-info → dynaref-6.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: DynaRef
-Version: 6.5.2
+Version: 6.5.3
 Summary: Dyna: X-ray magnetic reflectivity simulation
 Author-email: Stephane Grenier <stephane.grenier@neel.cnrs.fr>
 License-Expression: GPL-2.0-or-later

{dynaref-6.5.2 → dynaref-6.5.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "DynaRef"
-version = "6.5.2"
+version = "6.5.3"
 description = "Dyna: X-ray magnetic reflectivity simulation"
 readme = "README.md"
 requires-python = ">=3.10"

{dynaref-6.5.2 → dynaref-6.5.3/src/DynaRef.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: DynaRef
-Version: 6.5.2
+Version: 6.5.3
 Summary: Dyna: X-ray magnetic reflectivity simulation
 Author-email: Stephane Grenier <stephane.grenier@neel.cnrs.fr>
 License-Expression: GPL-2.0-or-later

{dynaref-6.5.2 → dynaref-6.5.3}/src/DynaRef.egg-info/SOURCES.txt

@@ -993,6 +993,7 @@ tests/test_FeSiMultifitExample.py
 tests/test_GUIPlotFunctions.py
 tests/test_GUIProjectYAML.py
 tests/test_GUIResponsiveness.py
+tests/test_GUIUserData.py
 tests/test_HeadlessFittingAPI.py
 tests/test_HeadlessSimulationAPI.py
 tests/test_KerrLiteratureBenchmark.py

{dynaref-6.5.2 → dynaref-6.5.3}/src/dyna/__init__.py

@@ -124,7 +124,12 @@ from dyna.workflow.fitting import (
     run_fit,
     run_multifit,
 )
-from dyna.workflow.examples import example_path, export_examples, list_examples
+from dyna.workflow.examples import (
+    ensure_examples,
+    example_path,
+    export_examples,
+    list_examples,
+)
 from dyna.workflow.project import (
     load_project_yaml,
     load_sample_yaml,
@@ -154,6 +159,7 @@ __all__ = [
     "ScanRange",
     "SimulationConfig",
     "build_scattering_factors",
+    "ensure_examples",
     "example_path",
     "export_examples",
     "list_examples",

{dynaref-6.5.2 → dynaref-6.5.3}/src/dyna/gui/DynaGUIClass.py

@@ -54,6 +54,7 @@ from dyna.scattering.factors import (
     SF_AllocCalc,
     list_scattering_factor_names,
 )
+from dyna.workflow.examples import ensure_examples
 from dyna.workflow.project import (
     load_project_yaml,
     save_project_yaml,
@@ -284,9 +285,14 @@ class DynaGUI(QMainWindow, config.load_form_class()):
         super().__init__(parent)
 
         try:
-            config.ensure_user_directories()
+            user_root = config.ensure_user_directories()
         except OSError as exc:
             print(f"Could not initialize Dyna user directory: {exc}")
+        else:
+            try:
+                ensure_examples(user_root / "examples")
+            except OSError as exc:
+                print(f"Could not provision Dyna examples: {exc}")
 
         self.ProjectName = [
             config.projects_path / "project.yaml",

{dynaref-6.5.2 → dynaref-6.5.3}/src/dyna/resources/examples/README.md

@@ -4,8 +4,11 @@ These examples show how to use Dyna without starting the graphical interface.
 They are meant to be copied and adapted to your own samples, scan ranges, and
 experimental data.
 
-PyPI installations include this complete example collection. Export an
-editable copy to the persistent ``~/DynaUser/examples`` directory with:
+PyPI installations include this complete example collection. Starting the
+Dyna GUI automatically copies missing examples into the persistent
+``~/DynaUser/examples`` directory without replacing existing files.
+
+For a headless installation, export an editable copy manually with:
 
 ```console
 dyna-sim examples --export

{dynaref-6.5.2 → dynaref-6.5.3}/src/dyna/workflow/__init__.py

@@ -19,7 +19,12 @@ from dyna.workflow.fitting import (
     run_fit,
     run_multifit,
 )
-from dyna.workflow.examples import example_path, export_examples, list_examples
+from dyna.workflow.examples import (
+    ensure_examples,
+    example_path,
+    export_examples,
+    list_examples,
+)
 from dyna.workflow.project import (
     load_project_yaml,
     load_sample_yaml,
@@ -53,6 +58,7 @@ __all__ = [
     "SampleConfig",
     "ScanRange",
     "SimulationConfig",
+    "ensure_examples",
     "example_path",
     "export_examples",
     "list_examples",

{dynaref-6.5.2 → dynaref-6.5.3}/src/dyna/workflow/examples.py

@@ -91,3 +91,52 @@ def export_examples(
         target.write_bytes(resource.read_bytes())
 
     return destination
+
+
+def ensure_examples(destination: str | Path | None = None) -> Path:
+    """Copy missing bundled examples without changing existing user files."""
+    destination = (
+        config.examples_path if destination is None else Path(destination)
+    ).expanduser()
+    example_files = _example_files()
+    blockers = set()
+
+    if destination.exists() and not destination.is_dir():
+        blockers.add(destination)
+
+    for relative, _resource in example_files:
+        target = destination.joinpath(*PurePosixPath(relative).parts)
+        if target.exists():
+            if not target.is_file():
+                blockers.add(target)
+            continue
+
+        parent = target.parent
+        while True:
+            if parent.exists() and not parent.is_dir():
+                blockers.add(parent)
+                break
+            if parent == destination:
+                break
+            parent = parent.parent
+
+    if blockers:
+        sorted_blockers = sorted(blockers, key=str)
+        names = ", ".join(str(path) for path in sorted_blockers[:3])
+        if len(blockers) > 3:
+            names += f", and {len(blockers) - 3} more"
+        raise FileExistsError(
+            f"cannot provision examples because paths are not directories or "
+            f"files as expected: {names}"
+        )
+
+    destination.mkdir(parents=True, exist_ok=True)
+    for relative, resource in example_files:
+        target = destination.joinpath(*PurePosixPath(relative).parts)
+        if target.exists():
+            continue
+        target.parent.mkdir(parents=True, exist_ok=True)
+        with target.open("xb") as output:
+            output.write(resource.read_bytes())
+
+    return destination

dynaref-6.5.3/tests/test_GUIUserData.py

@@ -0,0 +1,11 @@
+"""GUI startup tests for persistent user data."""
+
+from dyna import example_path
+
+
+def test_gui_startup_provisions_examples(dyna_app, isolated_user_data):
+    exported = isolated_user_data / "examples" / "workflows" / "stepanov-angle.yaml"
+
+    assert exported.read_bytes() == example_path(
+        "workflows/stepanov-angle.yaml"
+    ).read_bytes()

{dynaref-6.5.2 → dynaref-6.5.3}/tests/test_PackagedExamples.py

@@ -4,7 +4,7 @@ from pathlib import Path
 
 import pytest
 
-from dyna import example_path, export_examples, list_examples
+from dyna import ensure_examples, example_path, export_examples, list_examples
 
 
 pytestmark = pytest.mark.no_gui
@@ -76,6 +76,33 @@ def test_export_can_deliberately_restore_packaged_files(tmp_path):
     assert changed.read_bytes() == example_path("README.md").read_bytes()
 
 
+def test_ensure_examples_adds_missing_files_without_changing_existing_ones(tmp_path):
+    destination = tmp_path / "examples"
+    destination.mkdir()
+    changed = destination / "README.md"
+    changed.write_text("my adapted example\n", encoding="utf-8")
+
+    result = ensure_examples(destination)
+
+    assert result == destination
+    assert changed.read_text(encoding="utf-8") == "my adapted example\n"
+    assert (destination / "workflows" / "stepanov-angle.yaml").is_file()
+
+    ensure_examples(destination)
+    assert changed.read_text(encoding="utf-8") == "my adapted example\n"
+
+
+def test_ensure_examples_checks_for_blocking_paths_before_copying(tmp_path):
+    destination = tmp_path / "examples"
+    destination.mkdir()
+    (destination / "workflows").write_text("not a directory\n", encoding="utf-8")
+
+    with pytest.raises(FileExistsError, match="cannot provision examples"):
+        ensure_examples(destination)
+
+    assert not (destination / "README.md").exists()
+
+
 def test_packaged_example_mirror_matches_repository_examples():
     repository_root = Path(__file__).resolve().parents[1]
     source_root = repository_root / "examples"