figscribe 0.0.1__tar.gz

figscribe-0.0.1/.gitignore

@@ -0,0 +1,29 @@
+# macOS
+.DS_Store
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+
+# Tests and tooling
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Test artifacts (image comparisons)
+tests/**/output/
+*.actual.png
+
+# Editors
+.idea/
+.vscode/

figscribe-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 f4ren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

figscribe-0.0.1/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.5
+Name: figscribe
+Version: 0.0.1
+Summary: A lean desktop GUI for scientific Matplotlib plots that exports clean, standalone Python code instead of a proprietary project file.
+Project-URL: Homepage, https://github.com/f4ren/figscribe
+Project-URL: Source, https://github.com/f4ren/figscribe
+Project-URL: Issues, https://github.com/f4ren/figscribe/issues
+Author: Christian Krause
+License-Expression: MIT
+License-File: LICENSE
+Keywords: code-generation,gui,matplotlib,plotting,science
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# figscribe
+
+A lean desktop GUI for scientific plots: build and fine-tune figures
+interactively, and get **clean, standalone Python code** (Matplotlib) as the
+result instead of a proprietary project file.
+
+Intended for scientists and engineers who find Origin unwieldy but don't want to
+hand-write every detail of a Matplotlib figure just to fine-tune it.
+
+## Status
+
+**Very early — planning stage.** Nothing usable has been implemented yet; the
+PyPI entry is a placeholder release that reserves the name.
+
+The full project plan lives in [`plan/`](plan/).
+
+## Design principle
+
+The declarative plot model is the single source of truth:
+
+```
+Plot model (typed, JSON-serializable)
+   ├──> Renderer:       model -> Matplotlib figure (GUI preview AND export)
+   ├──> Code generator:  model -> standalone Python script
+   └──> Persistence:    model <-> JSON project file
+```
+
+The GUI only ever reads and mutates the model, through commands with undo/redo —
+it never manipulates Matplotlib objects directly. Preview and export share the
+same renderer, so what you see is what you get. The generated code reproduces the
+same figure and runs without figscribe installed.
+
+## Scope
+
+Planned for the MVP: data import (CSV, HDF5, NPY/NPZ), line/scatter/errorbar
+plots, histograms, 2D images and color meshes, curve fitting via
+`scipy.optimize.curve_fit`, multi-panel layouts with shared axes, LaTeX labels,
+undo/redo, export to PDF/SVG/PNG at exact millimeter sizes, and Matplotlib style
+templates for journal-column widths.
+
+Deliberately out of scope: spreadsheet-style data editing, a statistics suite, a
+custom scripting language, and reading generated or third-party Python code back
+in.
+
+## Stack
+
+Python >= 3.11, PySide6, Matplotlib, NumPy, SciPy, h5py.
+
+## License
+
+MIT, see [LICENSE](LICENSE).

figscribe-0.0.1/README.md

@@ -0,0 +1,51 @@
+# figscribe
+
+A lean desktop GUI for scientific plots: build and fine-tune figures
+interactively, and get **clean, standalone Python code** (Matplotlib) as the
+result instead of a proprietary project file.
+
+Intended for scientists and engineers who find Origin unwieldy but don't want to
+hand-write every detail of a Matplotlib figure just to fine-tune it.
+
+## Status
+
+**Very early — planning stage.** Nothing usable has been implemented yet; the
+PyPI entry is a placeholder release that reserves the name.
+
+The full project plan lives in [`plan/`](plan/).
+
+## Design principle
+
+The declarative plot model is the single source of truth:
+
+```
+Plot model (typed, JSON-serializable)
+   ├──> Renderer:       model -> Matplotlib figure (GUI preview AND export)
+   ├──> Code generator:  model -> standalone Python script
+   └──> Persistence:    model <-> JSON project file
+```
+
+The GUI only ever reads and mutates the model, through commands with undo/redo —
+it never manipulates Matplotlib objects directly. Preview and export share the
+same renderer, so what you see is what you get. The generated code reproduces the
+same figure and runs without figscribe installed.
+
+## Scope
+
+Planned for the MVP: data import (CSV, HDF5, NPY/NPZ), line/scatter/errorbar
+plots, histograms, 2D images and color meshes, curve fitting via
+`scipy.optimize.curve_fit`, multi-panel layouts with shared axes, LaTeX labels,
+undo/redo, export to PDF/SVG/PNG at exact millimeter sizes, and Matplotlib style
+templates for journal-column widths.
+
+Deliberately out of scope: spreadsheet-style data editing, a statistics suite, a
+custom scripting language, and reading generated or third-party Python code back
+in.
+
+## Stack
+
+Python >= 3.11, PySide6, Matplotlib, NumPy, SciPy, h5py.
+
+## License
+
+MIT, see [LICENSE](LICENSE).

figscribe-0.0.1/plan/project-brief.md

@@ -0,0 +1,179 @@
+# Project brief: figscribe
+
+## Goal
+
+Build a lean desktop GUI for scientific plots that lets you create and fine-tune
+figures interactively and produces **clean, standalone Python code**
+(Matplotlib) as its output, rather than a proprietary project file.
+
+Audience: scientists and engineers who find Origin unwieldy but don't want to
+hand-write every detail in Matplotlib just to fine-tune a figure.
+
+## Architectural principle (binding)
+
+**The declarative plot model is the single source of truth.**
+
+```
+Plot model (dataclasses, JSON-serializable)
+   │
+   ├──> Renderer:        model -> Matplotlib figure (for GUI preview AND export)
+   ├──> Code generator:  model -> standalone Python script
+   └──> Persistence:     model <-> JSON project file
+GUI: reads and mutates the model exclusively, via commands (see undo/redo)
+```
+
+Rules:
+- The GUI never manipulates Matplotlib objects directly in a persistent way.
+  Every change runs as a command against the model, followed by a re-render.
+- Preview and export use the same renderer. What you see is exactly what gets
+  exported (at the same figure size and DPI).
+- The generated code must run without figscribe installed and must produce the
+  same figure as the renderer.
+- Reading generated code back in is **not** a goal. Users are free to edit the
+  code further; from that point it is theirs.
+
+## Plot model (first draft, may be refined)
+
+- `Project`: list of `Figure`, list of `DataSource`, metadata (version, creation
+  date)
+- `DataSource`: path, format (CSV, HDF5, NPY/NPZ), import options (delimiter,
+  header row, HDF5 dataset path), SHA-256 of the file
+- `Figure`: size in mm, DPI, stylesheet, layout (grid of rows and columns,
+  shared axes)
+- `Axes`: position in the grid, x/y label (LaTeX allowed), units, scale
+  (linear/log/symlog), limits (auto or fixed), ticks, optional secondary y-axis,
+  legend (position, visibility, frame)
+- `Artist` (union type):
+  - `LinePlot`, `ScatterPlot`, `ErrorbarPlot` (x, y, xerr, yerr as column
+    references)
+  - `Histogram` (bins, normalization)
+  - `ImagePlot` / `ColorMesh` (2D data, colormap, colorbar, normalization)
+  - `FitCurve` (reference to a data artist, model function, initial values,
+    resulting parameters with uncertainties, optional residual panel)
+  - `Annotation` (text, position in data or axes coordinates, optional arrow)
+- Style properties per artist: color, line style, marker, line width, alpha,
+  label, z-order
+
+All model classes: typed, validatable, losslessly JSON-serializable with a
+schema version for later migrations.
+
+## MVP feature set
+
+1. **Data import**: CSV, HDF5, NPY/NPZ. Column preview, selection of columns for
+   x, y and errors. No spreadsheet, no column formulas.
+2. **Plotting**: the artist types from the model.
+3. **Canvas interaction**:
+   - Click an element: it gets selected, its properties appear in the property
+     panel
+   - Drag the legend, annotations and labels to move them
+   - Zoom and pan, and adopt the current view as fixed limits
+4. **Property panel**: generated generically from the model fields, with
+   specialized editors where it makes sense (color picker, marker selection).
+5. **Axes**: log/linear, secondary y-axis, LaTeX labels, units.
+6. **Layouts**: multi-panel grid with shared axes.
+7. **Fits**: `scipy.optimize.curve_fit`, predefined models (linear, polynomial,
+   Gaussian, Lorentzian, exponential) plus a custom expression. Output:
+   parameters with 1-sigma uncertainties, reduced chi-square, optional residual
+   plot.
+8. **Undo/redo**: command pattern across all model changes.
+9. **Export**: PDF, SVG and PNG at exact sizes in mm.
+10. **Code generation**: a single Python script with
+    - header: date, figscribe version, package versions, data paths with SHA-256
+    - data loading, plotting and saving in clearly commented sections
+    - only standard dependencies (numpy, matplotlib, optionally scipy, h5py)
+11. **Style templates**: Matplotlib stylesheets (`.mplstyle`), shipping with a
+    neutral default and a journal-style template (single column approx. 85 mm,
+    double column approx. 175 mm).
+
+## Deliberate non-goals
+
+- No spreadsheet or data editing
+- No statistics suite
+- No custom scripting language
+- No reading back generated or third-party Python code
+- No Origin import in the MVP (possibly later for .opj via liborigin)
+
+## Non-functional requirements
+
+- Pixel-identical agreement between preview and export
+- Fluid interaction up to approx. 10^6 data points (downsampling in the preview
+  only; export always uses the full data)
+- Platforms: Linux, Windows, macOS
+- Reproducibility: project file and generated code contain data hashes and
+  versions
+
+## Technical stack
+
+- Python >= 3.11
+- PySide6 (Qt) for the GUI, Matplotlib canvas via `FigureCanvasQTAgg`
+- Matplotlib as the only renderer
+- NumPy, SciPy, h5py
+- Model: dataclasses or pydantic (make a reasoned decision and document it)
+- Tests: pytest, pytest-qt
+- Packaging: `pyproject.toml`, later PyInstaller or Briefcase for installers
+- License: MIT
+
+## Proposed project structure
+
+```
+figscribe/
+  model/        # dataclasses, validation, JSON (de)serialization, schema versions
+  render/       # model -> Matplotlib
+  codegen/      # model -> Python script
+  io/           # data import (CSV, HDF5, NPY)
+  fit/          # fit models and execution
+  commands/     # command pattern, undo/redo
+  gui/          # main window, canvas, property panel, dialogs
+  styles/       # bundled .mplstyle files
+tests/
+examples/       # example data and example projects
+```
+
+## Test strategy (important)
+
+1. **Model roundtrip**: model -> JSON -> model yields equality.
+2. **Codegen equivalence** (core test): for each example project
+   - the renderer produces PNG A
+   - the generated script is run in a subprocess and produces PNG B
+   - A and B must be pixel-identical (or within a very small, justified
+     tolerance)
+3. **Image regression tests** for the renderer against reference images.
+4. **Command tests**: every change must be exactly reversible via undo.
+5. **GUI smoke tests** with pytest-qt.
+
+## Milestones
+
+1. **M1 model and renderer**: model, JSON persistence, renderer for line,
+   scatter and errorbar, export. No GUI yet. Tests 1 and 3.
+2. **M2 code generator**: codegen for all M1 features, equivalence test (test 2)
+   green.
+3. **M3 GUI skeleton**: main window, data import dialog, canvas, click to
+   select, generic property panel, undo/redo.
+4. **M4 interaction**: drag for legend, labels and annotations, adopt zoom as
+   limits.
+5. **M5 extensions**: multi-panel layouts, secondary y-axis, histogram, 2D
+   plots, colorbar.
+6. **M6 fits**: fit dialog, result display, residual panel, codegen including
+   the fit.
+7. **M7 polish**: style templates, snapping and alignment guides, packaging.
+
+Every milestone ends with green tests and a runnable state.
+
+## Working agreement for the coding agent
+
+- Before M1: present the plot model as a code draft with a rationale, and only
+  then implement.
+- Work in small, test-driven steps: test first, then implementation.
+- Record architectural decisions briefly in `docs/decisions.md` (context,
+  decision, alternatives).
+- No new dependencies without a rationale.
+- When the model is unclear, ask rather than guess.
+- Generated code should look the way an experienced human would write it:
+  readable, commented, free of figscribe-internal helper functions.
+
+## Optional, after the MVP
+
+- Natural-language input via an LLM that produces **commands against the model**
+  (not code), so that everything stays traceable and undoable.
+- Import of older Origin projects (.opj) via liborigin.
+- Live data mode (watch a file, update the plot).

figscribe-0.0.1/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "figscribe"
+version = "0.0.1"
+description = "A lean desktop GUI for scientific Matplotlib plots that exports clean, standalone Python code instead of a proprietary project file."
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [{ name = "Christian Krause" }]
+keywords = ["matplotlib", "plotting", "gui", "science", "code-generation"]
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "Environment :: X11 Applications :: Qt",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/f4ren/figscribe"
+Source = "https://github.com/f4ren/figscribe"
+Issues = "https://github.com/f4ren/figscribe/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/figscribe"]

figscribe-0.0.1/src/figscribe/__init__.py

@@ -0,0 +1,7 @@
+"""figscribe - scientific plots via a GUI, exported as standalone Python code.
+
+This is a placeholder release that reserves the package name. Implementation has
+not started yet; see the project repository for the plan.
+"""
+
+__version__ = "0.0.1"