ReForma 0.1.0__tar.gz → 0.1.2__tar.gz

{reforma-0.1.0 → reforma-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ReForma
-Version: 0.1.0
+Version: 0.1.2
 Summary: Python bindings for the RePA/ReForma probabilistic automaton tool
 Author-email: Joshua Dourado <joshuadourado@ua.pt>
 License: MIT
@@ -13,21 +13,27 @@ Description-Content-Type: text/markdown
 Requires-Dist: networkx
 Requires-Dist: matplotlib
 
-# ReForma — Python bindings for the RePA/ReForma tool
+# ReForma — Reconfigurable Formal Automata in Python
 
-A clean Python library that wraps the `ReFormaTool.jar` CLI via subprocess,
+A clean Python library that wraps the `RePATool.jar` CLI via subprocess,
 giving you a Pythonic interface for simulation, training, PDL/PCTL
-verification, and export.
+verification, and interactive graph visualizations.
 
 ---
 
 ## Installation
 
+You can install it directly from PyPI (once published):
 ```bash
-# From the project root (where pyproject.toml lives)
-pip install -e .
+pip install reforma
 ```
 
+For **visualization features** (offline PNGs and interactive Jupyter graphs), install the required extras:
+```bash
+pip install networkx matplotlib
+```
+
+*(Local Development: Run `pip install -e .` from the project root).* 
 Requires **Python 3.10+** and a working `java` on your PATH.
 
 ---
@@ -35,73 +41,84 @@ Requires **Python 3.10+** and a working `java` on your PATH.
 ## Quick Start
 
 ```python
-from ReForma import ReForma
+from reforma import ReForma
 
-# Point to your compiled JAR
-ReForma = ReForma("path/to/ReFormaTool.jar")
+modelo = ReForma()
 
 # Load a model
-state = ReForma.load_file("examples/recommender.r")
+state = modelo.load_file("recommender.r")
 
-print(state.current_states)   # ['Home']
-print(state.enabled)          # [Transition('go_work': Home → Office, p=0.500), ...]
+# Get a beautiful printout of the current state and probabilities
+print(state.summary())
 
 # Simulate
-state = ReForma.step("go_work")
-state = ReForma.step("easy_task")
-state = ReForma.undo()            # undo last step
+state = modelo.step("go_work")
+state = modelo.step("easy_task")
+
+# Undo last step
+state = modelo.undo()            
 
 # Reset to initial state
-ReForma.reset()
+modelo.reset()
 ```
 
 ---
 
-## Simulation
+## Visualization (Jupyter & Offline)
+
+ReForma provides powerful graphing tools directly integrated into your workflow.
 
 ```python
-state = ReForma.load_file("model.r")
+from reforma import ReForma
 
-# Check what's enabled
-for t in state.enabled:
-    print(f"{t.label}: {t.from_state} → {t.to_state}  (p={t.probability:.3f})")
+modelo = ReForma()
+modelo.load_file("model.r")
 
-# Take a step by label
-state = ReForma.step("go_work")
+# 1. Interactive Jupyter View 
+# Renders a drag-and-drop Cytoscape.js graph right inside your Notebook!
+modelo.show_interactive()
 
-# Undo / reset
-state = ReForma.undo()
-state = ReForma.reset()
+# 2. Offline Static Images
+# Renders a high-res graph using Matplotlib/NetworkX (no browser needed)
+modelo.save_image_plt("output/my_graph.png")
+```
+
+---
+
+## Simulation & State Inspection
+
+```python
+state = modelo.load_file("model.r")
 
 # Inspect variables
 print(state.variables)   # {'counter': 0, 'flag': 1}
 
+# Check enabled transitions manually
+for t in state.enabled:
+    print(f"{t.label}: {t.from_state} → {t.to_state}  (p={t.probability:.3f})")
+
 # History of labels taken
-print(ReForma.history)       # ['go_work']
+print(modelo.history)    # ['go_work', 'easy_task']
 ```
 
 ---
 
 ## Training
 
-Train the model on a batch of sessions (lists of event labels):
+Train the model on a batch of sessions (lists of event labels) to automatically update the weights:
 
 ```python
-ReForma.train([
+modelo.train([
     ["go_work", "easy_task", "easy_task", "go_home"],
     ["battery_low", "go_charge", "finish_charge", "socialize"],
     ["no_money", "go_work", "go_home"],
 ])
 
 # Or train directly from a log file (one session per line, comma-separated)
-ReForma.train_from_file("logs/sessions.txt")
-
-# sessions.txt format:
-#   go_work,easy_task,go_home
-#   battery_low,go_charge,finish_charge
+modelo.train_from_file("logs/sessions.txt")
 
-# Save the updated model with new weights
-ReForma.save_source("model_trained.r")
+# Save the updated model with the new calculated weights
+modelo.save_source("model_trained.r")
 ```
 
 ---
@@ -110,19 +127,19 @@ ReForma.save_source("model_trained.r")
 
 ```python
 # Quantitative: probability of eventually reaching Office
-prob = ReForma.check_pdl_value("Home", "{P=?[F Office]}")
+prob = modelo.check_pdl_value("Home", "{P=?[F Office]}")
 print(f"P(reach Office from Home) = {prob:.4f}")
 
 # Qualitative: is it probable?
-holds = ReForma.check_pdl_value("Home", "{P>=0.4[F Office]}")
+holds = modelo.check_pdl_value("Home", "{P>=0.4[F Office]}")
 print(f"P>=0.4? {holds}")   # True / False
 
 # PDL: is there a path via go_work to Office?
-holds = ReForma.check_pdl_value("Home", "<go_work>Office")
+holds = modelo.check_pdl_value("Home", "<go_work>Office")
 print(holds)   # True
 
 # Get the raw string result
-raw = ReForma.check_pdl("Home", "{P=?[F Office]}")
+raw = modelo.check_pdl("Home", "{P=?[F Office]}")
 print(raw)  # "Result: 0.50000"
 ```
 
@@ -144,20 +161,17 @@ print(raw)  # "Result: 0.50000"
 
 ```python
 # PRISM DTMC
-prism_code = ReForma.export_prism()
-ReForma.save_prism("output/model.pm")
-
-# mCRL2
-mcrl2_code = ReForma.export_mcrl2()
+prism_code = modelo.export_prism()
+modelo.save_prism("output/model.pm")
 
 # GLTS (imperative translation)
-glts_code = ReForma.export_glts()
+glts_code = modelo.export_glts()
 
 # Mermaid diagram (initial state)
-diagram = ReForma.export_mermaid()
+diagram = modelo.export_mermaid()
 
 # Mermaid diagram (full LTS — all reachable states)
-full_diagram = ReForma.export_mermaid(full_lts=True)
+full_diagram = modelo.export_mermaid(full_lts=True)
 ```
 
 ---
@@ -173,45 +187,22 @@ s0 ---> s2: b (0.4)
 s1 ---> s0: back (1.0)
 """
 
-state = ReForma.load(source, name="MyModel")
+state = modelo.load(source, name="MyModel")
 ```
 
----
-
-## Running the tests
-
-```bash
-pip install pytest
-pytest tests/ -v
-```
-
----
-
-## Project structure
-
-```
-ReForma/
-├── __init__.py       # Public API exports
-├── client.py         # ReForma — high-level Python API
-├── jar_bridge.py     # JarBridge — low-level subprocess wrapper
-└── model.py          # ReFormaModel, SimulationState, Transition data classes
-tests/
-└── test_ReForma.py       # Full test suite (mocked, no JAR needed)
-pyproject.toml
-README.md
-```
 
 ---
 
 ## Error handling
 
 ```python
-from ReForma.jar_bridge import JarError
+from reforma.jar_bridge import JarError
 
 try:
-    result = ReForma.check_pdl("Home", "{P=?[F Office]}")
+    result = modelo.check_pdl("Home", "{P=?[F Office]}")
 except JarError as e:
     print(f"JAR error: {e}")
 except RuntimeError as e:
     print(f"Usage error: {e}")   # e.g. no model loaded, invalid transition
 ```
+```

{reforma-0.1.0 → reforma-0.1.2}/README.md

@@ -1,18 +1,24 @@
-# ReForma — Python bindings for the RePA/ReForma tool
+# ReForma — Reconfigurable Formal Automata in Python
 
-A clean Python library that wraps the `ReFormaTool.jar` CLI via subprocess,
+A clean Python library that wraps the `RePATool.jar` CLI via subprocess,
 giving you a Pythonic interface for simulation, training, PDL/PCTL
-verification, and export.
+verification, and interactive graph visualizations.
 
 ---
 
 ## Installation
 
+You can install it directly from PyPI (once published):
 ```bash
-# From the project root (where pyproject.toml lives)
-pip install -e .
+pip install reforma
 ```
 
+For **visualization features** (offline PNGs and interactive Jupyter graphs), install the required extras:
+```bash
+pip install networkx matplotlib
+```
+
+*(Local Development: Run `pip install -e .` from the project root).* 
 Requires **Python 3.10+** and a working `java` on your PATH.
 
 ---
@@ -20,73 +26,84 @@ Requires **Python 3.10+** and a working `java` on your PATH.
 ## Quick Start
 
 ```python
-from ReForma import ReForma
+from reforma import ReForma
 
-# Point to your compiled JAR
-ReForma = ReForma("path/to/ReFormaTool.jar")
+modelo = ReForma()
 
 # Load a model
-state = ReForma.load_file("examples/recommender.r")
+state = modelo.load_file("recommender.r")
 
-print(state.current_states)   # ['Home']
-print(state.enabled)          # [Transition('go_work': Home → Office, p=0.500), ...]
+# Get a beautiful printout of the current state and probabilities
+print(state.summary())
 
 # Simulate
-state = ReForma.step("go_work")
-state = ReForma.step("easy_task")
-state = ReForma.undo()            # undo last step
+state = modelo.step("go_work")
+state = modelo.step("easy_task")
+
+# Undo last step
+state = modelo.undo()            
 
 # Reset to initial state
-ReForma.reset()
+modelo.reset()
 ```
 
 ---
 
-## Simulation
+## Visualization (Jupyter & Offline)
+
+ReForma provides powerful graphing tools directly integrated into your workflow.
 
 ```python
-state = ReForma.load_file("model.r")
+from reforma import ReForma
 
-# Check what's enabled
-for t in state.enabled:
-    print(f"{t.label}: {t.from_state} → {t.to_state}  (p={t.probability:.3f})")
+modelo = ReForma()
+modelo.load_file("model.r")
 
-# Take a step by label
-state = ReForma.step("go_work")
+# 1. Interactive Jupyter View 
+# Renders a drag-and-drop Cytoscape.js graph right inside your Notebook!
+modelo.show_interactive()
 
-# Undo / reset
-state = ReForma.undo()
-state = ReForma.reset()
+# 2. Offline Static Images
+# Renders a high-res graph using Matplotlib/NetworkX (no browser needed)
+modelo.save_image_plt("output/my_graph.png")
+```
+
+---
+
+## Simulation & State Inspection
+
+```python
+state = modelo.load_file("model.r")
 
 # Inspect variables
 print(state.variables)   # {'counter': 0, 'flag': 1}
 
+# Check enabled transitions manually
+for t in state.enabled:
+    print(f"{t.label}: {t.from_state} → {t.to_state}  (p={t.probability:.3f})")
+
 # History of labels taken
-print(ReForma.history)       # ['go_work']
+print(modelo.history)    # ['go_work', 'easy_task']
 ```
 
 ---
 
 ## Training
 
-Train the model on a batch of sessions (lists of event labels):
+Train the model on a batch of sessions (lists of event labels) to automatically update the weights:
 
 ```python
-ReForma.train([
+modelo.train([
     ["go_work", "easy_task", "easy_task", "go_home"],
     ["battery_low", "go_charge", "finish_charge", "socialize"],
     ["no_money", "go_work", "go_home"],
 ])
 
 # Or train directly from a log file (one session per line, comma-separated)
-ReForma.train_from_file("logs/sessions.txt")
-
-# sessions.txt format:
-#   go_work,easy_task,go_home
-#   battery_low,go_charge,finish_charge
+modelo.train_from_file("logs/sessions.txt")
 
-# Save the updated model with new weights
-ReForma.save_source("model_trained.r")
+# Save the updated model with the new calculated weights
+modelo.save_source("model_trained.r")
 ```
 
 ---
@@ -95,19 +112,19 @@ ReForma.save_source("model_trained.r")
 
 ```python
 # Quantitative: probability of eventually reaching Office
-prob = ReForma.check_pdl_value("Home", "{P=?[F Office]}")
+prob = modelo.check_pdl_value("Home", "{P=?[F Office]}")
 print(f"P(reach Office from Home) = {prob:.4f}")
 
 # Qualitative: is it probable?
-holds = ReForma.check_pdl_value("Home", "{P>=0.4[F Office]}")
+holds = modelo.check_pdl_value("Home", "{P>=0.4[F Office]}")
 print(f"P>=0.4? {holds}")   # True / False
 
 # PDL: is there a path via go_work to Office?
-holds = ReForma.check_pdl_value("Home", "<go_work>Office")
+holds = modelo.check_pdl_value("Home", "<go_work>Office")
 print(holds)   # True
 
 # Get the raw string result
-raw = ReForma.check_pdl("Home", "{P=?[F Office]}")
+raw = modelo.check_pdl("Home", "{P=?[F Office]}")
 print(raw)  # "Result: 0.50000"
 ```
 
@@ -129,20 +146,17 @@ print(raw)  # "Result: 0.50000"
 
 ```python
 # PRISM DTMC
-prism_code = ReForma.export_prism()
-ReForma.save_prism("output/model.pm")
-
-# mCRL2
-mcrl2_code = ReForma.export_mcrl2()
+prism_code = modelo.export_prism()
+modelo.save_prism("output/model.pm")
 
 # GLTS (imperative translation)
-glts_code = ReForma.export_glts()
+glts_code = modelo.export_glts()
 
 # Mermaid diagram (initial state)
-diagram = ReForma.export_mermaid()
+diagram = modelo.export_mermaid()
 
 # Mermaid diagram (full LTS — all reachable states)
-full_diagram = ReForma.export_mermaid(full_lts=True)
+full_diagram = modelo.export_mermaid(full_lts=True)
 ```
 
 ---
@@ -158,45 +172,22 @@ s0 ---> s2: b (0.4)
 s1 ---> s0: back (1.0)
 """
 
-state = ReForma.load(source, name="MyModel")
+state = modelo.load(source, name="MyModel")
 ```
 
----
-
-## Running the tests
-
-```bash
-pip install pytest
-pytest tests/ -v
-```
-
----
-
-## Project structure
-
-```
-ReForma/
-├── __init__.py       # Public API exports
-├── client.py         # ReForma — high-level Python API
-├── jar_bridge.py     # JarBridge — low-level subprocess wrapper
-└── model.py          # ReFormaModel, SimulationState, Transition data classes
-tests/
-└── test_ReForma.py       # Full test suite (mocked, no JAR needed)
-pyproject.toml
-README.md
-```
 
 ---
 
 ## Error handling
 
 ```python
-from ReForma.jar_bridge import JarError
+from reforma.jar_bridge import JarError
 
 try:
-    result = ReForma.check_pdl("Home", "{P=?[F Office]}")
+    result = modelo.check_pdl("Home", "{P=?[F Office]}")
 except JarError as e:
     print(f"JAR error: {e}")
 except RuntimeError as e:
     print(f"Usage error: {e}")   # e.g. no model loaded, invalid transition
+```
 ```