Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
951431c
Converts print statements to logging
AndrewSazonov Oct 20, 2025
f47d062
Refactors plotting module to display module
AndrewSazonov Oct 20, 2025
b45da2b
Refines parameter handling and logging functionality
AndrewSazonov Oct 20, 2025
daf2e37
Refines CIF serialization and updates docs
AndrewSazonov Oct 20, 2025
b7a9da5
Refines renderer architecture and error handling
AndrewSazonov Oct 20, 2025
c391ad1
Refines logging and utils import structure
AndrewSazonov Oct 20, 2025
79ed29d
Refines table rendering and error handling logic
AndrewSazonov Oct 21, 2025
de85ec5
Enhances logging with customizable rich formatting
AndrewSazonov Oct 21, 2025
c368c60
Refactors plotting modules and updates test expectations
AndrewSazonov Oct 21, 2025
dafea5f
Refactors logger and environment detection functions
AndrewSazonov Oct 21, 2025
00a431d
Switches logging from log to console
AndrewSazonov Oct 21, 2025
468c6e6
Improves axis scaling for asciichartpy
AndrewSazonov Oct 21, 2025
67e9f08
Refactors logging utility with enhanced features
AndrewSazonov Oct 21, 2025
609e7d1
Renames utils module for clarity
AndrewSazonov Oct 21, 2025
94e44ee
Enhances display and tracking in analysis module
AndrewSazonov Oct 22, 2025
3a3a411
Disable Jupyter notebook output scrolling
AndrewSazonov Oct 22, 2025
743e78e
Rename environment checks for clarity
AndrewSazonov Oct 22, 2025
8fc98ef
Remove redundant type ignores and streamline exception handling
AndrewSazonov Oct 22, 2025
1c4be7f
Improves console width detection for flexible environments
AndrewSazonov Oct 22, 2025
fe61c8a
Refactors logging modes and console output methods
AndrewSazonov Oct 22, 2025
0f6946e
Enhances logging utilities with improved docs
AndrewSazonov Oct 22, 2025
4a2129a
Removes unused imports and obsolete functions
AndrewSazonov Oct 22, 2025
24c200f
Refactors logging architecture for clarity
AndrewSazonov Oct 22, 2025
1ff2c9a
Removes unused show_index parameter
AndrewSazonov Oct 22, 2025
b7cc8ec
Refactors logger configuration setup
AndrewSazonov Oct 22, 2025
954a402
Reorders render_table arguments for clarity
AndrewSazonov Oct 22, 2025
284be2e
Refactors parameter table rendering and identity handling
AndrewSazonov Oct 22, 2025
6bbb47c
Removes redundant header handling in render_table
AndrewSazonov Oct 22, 2025
4350c65
Adds structure refinement example scripts
AndrewSazonov Oct 22, 2025
fe75156
Refactors test environment detection logic
AndrewSazonov Oct 22, 2025
20393eb
Enhances table styling with padding and font size
AndrewSazonov Oct 22, 2025
b53030d
Refactors logger imports and removes lazy loading
AndrewSazonov Oct 22, 2025
d10c89c
Suppresses user warnings in pytest configuration
AndrewSazonov Oct 22, 2025
617f00f
Adds SPDX license headers to utils.py
AndrewSazonov Oct 22, 2025
0f16d61
Reorganizes display and logging structure
AndrewSazonov Oct 22, 2025
ea90354
Refines logging initialization and aliases
AndrewSazonov Oct 22, 2025
eb14dc2
Activates commented pre-commit hooks
AndrewSazonov Oct 22, 2025
225b23d
Adds SPDX license identifiers to init files
AndrewSazonov Oct 22, 2025
af7ffff
Enhances Pandas table styling
AndrewSazonov Oct 22, 2025
8ef08f0
Removes Jupyter-specific logic from CIF renderer
AndrewSazonov Oct 22, 2025
8408ccf
Updates deps
AndrewSazonov Oct 22, 2025
d497a54
Temporarily disable Jupyter scroll in MkDocs
AndrewSazonov Oct 23, 2025
1760560
Improves table styling for enhanced readability
AndrewSazonov Oct 23, 2025
57a91d6
Add conditional doc build for branch environments
AndrewSazonov Oct 23, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,14 @@ jobs:
# Input: docs/ directory containing the Markdown files
# Output: site/ directory containing the generated HTML files
- name: Build site with MkDocs
run: pixi run docs-build
run: |
if [[ "${CI_BRANCH}" == "develop" || "${CI_BRANCH}" == "master" || "${CI_BRANCH}" == "main" ]]; then
echo "📘 Building production docs for ${CI_BRANCH}"
pixi run docs-build
else
echo "📗 Building local docs for ${CI_BRANCH}"
pixi run docs-local
fi

# Set up the Pages action to configure the static files to be deployed
# NOTE: The repository must have GitHub Pages enabled and configured to build using GitHub Actions
Expand Down
12 changes: 6 additions & 6 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ repos:
pass_filenames: false
stages: [pre-push]

#- id: pixi-unit-tests
# name: pixi run unit-tests
# entry: pixi run unit-tests
# language: system
# pass_filenames: false
# stages: [pre-push]
- id: pixi-unit-tests
name: pixi run unit-tests
entry: pixi run unit-tests
language: system
pass_filenames: false
stages: [pre-push]
1 change: 1 addition & 0 deletions docs/api-reference/display.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: easydiffraction.display
2 changes: 1 addition & 1 deletion docs/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ available in EasyDiffraction:
space groups, and symmetry operations.
- [utils](utils.md) – Miscellaneous utility functions for formatting,
decorators, and general helpers.
- [plotting](plotting.md) – Tools for visualizing data and fitting results.
- [display](display.md) – Tools for plotting data and rendering tables.
- [project](project.md) – Defines the project and manages its state.
- [sample_models](sample_models.md) – Defines sample models, such as
crystallographic structures, and manages their properties.
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/io.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: easydiffraction.io
1 change: 0 additions & 1 deletion docs/api-reference/plotting.md

This file was deleted.

54 changes: 39 additions & 15 deletions docs/architecture/package-structure-full.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
│ │ ├── 📄 reporting.py
│ │ │ └── 🏷️ class FitResults
│ │ └── 📄 tracking.py
│ │ ├── 🏷️ class _TerminalLiveHandle
│ │ └── 🏷️ class FitProgressTracker
│ ├── 📁 minimizers
│ │ ├── 📄 __init__.py
Expand Down Expand Up @@ -93,6 +94,37 @@
│ ├── 📄 __init__.py
│ ├── 📄 crystallography.py
│ └── 📄 space_groups.py
├── 📁 display
│ ├── 📁 plotters
│ │ ├── 📄 __init__.py
│ │ ├── 📄 ascii.py
│ │ │ └── 🏷️ class AsciiPlotter
│ │ ├── 📄 base.py
│ │ │ └── 🏷️ class PlotterBase
│ │ └── 📄 plotly.py
│ │ └── 🏷️ class PlotlyPlotter
│ ├── 📁 tablers
│ │ ├── 📄 __init__.py
│ │ ├── 📄 base.py
│ │ │ └── 🏷️ class TableBackendBase
│ │ ├── 📄 pandas.py
│ │ │ └── 🏷️ class PandasTableBackend
│ │ └── 📄 rich.py
│ │ └── 🏷️ class RichTableBackend
│ ├── 📄 __init__.py
│ ├── 📄 base.py
│ │ ├── 🏷️ class RendererBase
│ │ └── 🏷️ class RendererFactoryBase
│ ├── 📄 plotting.py
│ │ ├── 🏷️ class PlotterEngineEnum
│ │ ├── 🏷️ class Plotter
│ │ └── 🏷️ class PlotterFactory
│ ├── 📄 tables.py
│ │ ├── 🏷️ class TableEngineEnum
│ │ ├── 🏷️ class TableRenderer
│ │ └── 🏷️ class TableRendererFactory
│ └── 📄 utils.py
│ └── 🏷️ class JupyterScrollManager
├── 📁 experiments
│ ├── 📁 categories
│ │ ├── 📁 background
Expand Down Expand Up @@ -192,19 +224,6 @@
│ ├── 📄 handler.py
│ │ └── 🏷️ class CifHandler
│ └── 📄 serialize.py
├── 📁 plotting
│ ├── 📁 plotters
│ │ ├── 📄 __init__.py
│ │ ├── 📄 plotter_ascii.py
│ │ │ └── 🏷️ class AsciiPlotter
│ │ ├── 📄 plotter_base.py
│ │ │ └── 🏷️ class PlotterBase
│ │ └── 📄 plotter_plotly.py
│ │ └── 🏷️ class PlotlyPlotter
│ ├── 📄 __init__.py
│ └── 📄 plotting.py
│ ├── 🏷️ class Plotter
│ └── 🏷️ class PlotterFactory
├── 📁 project
│ ├── 📄 __init__.py
│ ├── 📄 project.py
Expand Down Expand Up @@ -236,9 +255,14 @@
│ └── 🏷️ class Summary
├── 📁 utils
│ ├── 📄 __init__.py
│ ├── 📄 formatting.py
│ ├── 📄 environment.py
│ ├── 📄 logging.py
│ │ └── 🏷️ class Logger
│ │ ├── 🏷️ class IconifiedRichHandler
│ │ ├── 🏷️ class ConsoleManager
│ │ ├── 🏷️ class LoggerConfig
│ │ ├── 🏷️ class ExceptionHookManager
│ │ ├── 🏷️ class Logger
│ │ └── 🏷️ class ConsolePrinter
│ └── 📄 utils.py
├── 📄 __init__.py
└── 📄 __main__.py
Expand Down
26 changes: 17 additions & 9 deletions docs/architecture/package-structure-short.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,22 @@
│ ├── 📄 __init__.py
│ ├── 📄 crystallography.py
│ └── 📄 space_groups.py
├── 📁 display
│ ├── 📁 plotters
│ │ ├── 📄 __init__.py
│ │ ├── 📄 ascii.py
│ │ ├── 📄 base.py
│ │ └── 📄 plotly.py
│ ├── 📁 tablers
│ │ ├── 📄 __init__.py
│ │ ├── 📄 base.py
│ │ ├── 📄 pandas.py
│ │ └── 📄 rich.py
│ ├── 📄 __init__.py
│ ├── 📄 base.py
│ ├── 📄 plotting.py
│ ├── 📄 tables.py
│ └── 📄 utils.py
├── 📁 experiments
│ ├── 📁 categories
│ │ ├── 📁 background
Expand Down Expand Up @@ -96,14 +112,6 @@
│ └── 📁 cif
│ ├── 📄 handler.py
│ └── 📄 serialize.py
├── 📁 plotting
│ ├── 📁 plotters
│ │ ├── 📄 __init__.py
│ │ ├── 📄 plotter_ascii.py
│ │ ├── 📄 plotter_base.py
│ │ └── 📄 plotter_plotly.py
│ ├── 📄 __init__.py
│ └── 📄 plotting.py
├── 📁 project
│ ├── 📄 __init__.py
│ ├── 📄 project.py
Expand All @@ -125,7 +133,7 @@
│ └── 📄 summary.py
├── 📁 utils
│ ├── 📄 __init__.py
│ ├── 📄 formatting.py
│ ├── 📄 environment.py
│ ├── 📄 logging.py
│ └── 📄 utils.py
├── 📄 __init__.py
Expand Down
9 changes: 5 additions & 4 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,13 @@ nav:
- 2025 DMSC: tutorials/dmsc-summer-school-2025_analysis-powder-diffraction.ipynb
- API Reference:
- API Reference: api-reference/index.md
- analysis: api-reference/analysis.md
- core: api-reference/core.md
- crystallography: api-reference/crystallography.md
- utils: api-reference/utils.md
- plotting: api-reference/plotting.md
- display: api-reference/display.md
- experiments: api-reference/experiments.md
- io: api-reference/io.md
- project: api-reference/project.md
- sample_models: api-reference/sample_models.md
- experiments: api-reference/experiments.md
- analysis: api-reference/analysis.md
- summary: api-reference/summary.md
- utils: api-reference/utils.md
Loading
Loading