Skip to content

[213_01] Add an end-to-end reproducible Python workflow example for Conda, Pandas, Matplotlib, and SymPy #3073

@Uygniqoar

Description

@Uygniqoar

Summary

Mogan already supports:

  • starting Python sessions from Conda environments,
  • running executable code blocks inside documents,
  • rendering outputs such as Matplotlib plots, Pandas tables, and SymPy formulas.

However, there is not yet a single end-to-end official example that shows a reproducible research workflow from environment setup to output insertion inside a Mogan document.

I would like to contribute a documentation-oriented enhancement that provides a complete, reproducible example workflow for Python-based scientific writing in Mogan.

Motivation

At the moment, the Python plugin capability is visible in the documentation and release notes, but a new user or contributor still needs to piece together multiple pages to understand the standard workflow.

An official end-to-end example would help with:

  • onboarding new users,
  • making the Python workflow easier to reproduce,
  • giving contributors a stable reference example,
  • supporting a future GSoC proposal direction around reproducible Python research workflows.

Proposed scope

I plan to add a minimal but complete workflow example covering:

  1. Conda environment preparation
  2. Starting a Python session from Plugins -> Sessions -> Python
  3. Running executable Python code blocks inside a Mogan document
  4. Rendering and inserting:
    • a Pandas table
    • a Matplotlib figure
    • a SymPy-generated formula
  5. A short validation section describing the expected result and how to verify the workflow

Deliverables

  • One end-to-end example document for the Python workflow
  • One developer-oriented document explaining:
    • where the example lives,
    • what it covers,
    • how to validate it
  • A minimal validation or integration-style check description for maintainers

Acceptance criteria

This issue can be considered complete if:

  • a contributor can follow the example and start a Python session from a Conda environment,
  • the example produces a rendered table, plot, and formula inside Mogan,
  • the documentation is clear enough for a new user to reproduce the workflow,
  • the PR includes a developer document as required by the repository contribution rules.

Out of scope

This issue does not propose:

  • a new Python execution engine,
  • notebook-style kernel management,
  • AI assistant functionality,
  • large changes to the plugin protocol.

Notes

I am using 213 in the title because this first contribution is documentation/example-oriented, while it directly supports the Python workflow direction.
If maintainers prefer a different project number for this task, I can rename the title accordingly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions