Update single fit tutorial

Author: AndrewSazonov

.github/workflows/build-docs.yml

@@ -100,6 +100,7 @@ jobs:
       # The notebooks are used to generate the documentation
       - name: Convert ${{ env.NOTEBOOKS_DIR }}/*.py to docs/${{env.NOTEBOOKS_DIR }}/*.ipynb
         run: |
+          cp -R ${{ env.NOTEBOOKS_DIR }}/data docs/${{ env.NOTEBOOKS_DIR }}/
           jupytext ${{ env.NOTEBOOKS_DIR }}/*.py --to ipynb
           mv ${{ env.NOTEBOOKS_DIR }}/*.ipynb docs/${{ env.NOTEBOOKS_DIR }}/
 

src/easydiffraction/plotting/plotters/plotter_plotly.py

@@ -1,3 +1,4 @@
+import darkdetect
 import plotly.graph_objects as go
 import plotly.io as pio
 
@@ -14,7 +15,7 @@
 
 
 class PlotlyPlotter(PlotterBase):
-    pio.templates.default = 'plotly_white'
+    pio.templates.default = 'plotly_dark' if darkdetect.isDark() else 'plotly_white'
 
     def _get_trace(self, x, y, label):
         mode = SERIES_CONFIG[label]['mode']

src/easydiffraction/project.py

@@ -2,9 +2,8 @@
 import datetime
 import tempfile
 from textwrap import wrap
-
 from varname import varname
-from tabulate import tabulate
+from typing import List
 
 from easydiffraction.utils.formatting import (
     paragraph,
@@ -83,8 +82,8 @@ def update_last_modified(self) -> None:
 
     def as_cif(self) -> str:
         """Export project metadata to CIF."""
-        wrapped_title: List[str] = wrap(self.title, width=60)
-        wrapped_description: List[str] = wrap(self.description, width=60)
+        wrapped_title: List[str] = wrap(self.title, width=46)
+        wrapped_description: List[str] = wrap(self.description, width=46)
 
         title_str: str = f"_project.title            '{wrapped_title[0]}'"
         for line in wrapped_title[1:]:

src/easydiffraction/utils/formatting.py

@@ -8,37 +8,37 @@ def chapter(title: str) -> str:
     full_title = f" {title.upper()} "
     pad_len = (WIDTH - len(full_title)) // 2
     padding = SYMBOL * pad_len
-    line = f"{Fore.MAGENTA + Style.BRIGHT}{padding}{full_title}{padding}{Style.RESET_ALL}"
+    line = f"{Fore.LIGHTMAGENTA_EX + Style.BRIGHT}{padding}{full_title}{padding}{Style.RESET_ALL}"
     if len(line) < WIDTH:
         line += SYMBOL
     return f'\n{line}'
 
 def section(title: str) -> str:
     """Formats a section header with bold green text."""
     full_title = f'*** {title.upper()} ***'
-    return f"\n{Fore.GREEN + Style.BRIGHT}{full_title}{Style.RESET_ALL}"
+    return f"\n{Fore.LIGHTGREEN_EX + Style.BRIGHT}{full_title}{Style.RESET_ALL}"
 
 def paragraph(title: str) -> str:
     """Formats a subsection header with bold blue text while keeping quoted text unformatted."""
     import re
     parts = re.split(r"('.*?')", title)
-    formatted = f"{Fore.BLUE + Style.BRIGHT}"
+    formatted = f"{Fore.LIGHTBLUE_EX + Style.BRIGHT}"
     for part in parts:
         if part.startswith("'") and part.endswith("'"):
-            formatted += Style.RESET_ALL + part + Fore.BLUE + Style.BRIGHT
+            formatted += Style.RESET_ALL + part + Fore.LIGHTBLUE_EX + Style.BRIGHT
         else:
             formatted += part
     formatted += Style.RESET_ALL
     return f"\n{formatted}"
 
 def error(title: str) -> str:
     """Formats an error message with red text."""
-    return f"\n❌ {Fore.RED}Error{Style.RESET_ALL}\n{title}"
+    return f"\n❌ {Fore.LIGHTRED_EX}Error{Style.RESET_ALL}\n{title}"
 
 def warning(title: str) -> str:
     """Formats a warning message with yellow text."""
-    return f"\n⚠️ {Fore.YELLOW}Warning{Style.RESET_ALL}\n{title}"
+    return f"\n⚠️ {Fore.LIGHTYELLOW_EX}Warning{Style.RESET_ALL}\n{title}"
 
 def info(title: str) -> str:
     """Formats an info message with cyan text."""
-    return f"\nℹ️ {Fore.CYAN}Info{Style.RESET_ALL}\n{title}"
+    return f"\nℹ️ {Fore.LIGHTCYAN_EX}Info{Style.RESET_ALL}\n{title}"

tools/prepare_docs.sh

@@ -15,6 +15,7 @@ cp ../assets-branding/easydiffraction/icons/bw.svg overrides/.icons/easydiffract
 cp ../assets-branding/easyscience-org/icons/eso-icon_bw.svg overrides/.icons/easyscience.svg
 
 echo "\033[0;33m:::::: Add Jupyter notebooks from the project to the docs/\033[0m"
+cp -R tutorials/data docs/tutorials/
 jupytext tutorials/*.py --to ipynb
 mv tutorials/*.ipynb docs/tutorials/