rgwfuncs 0.0.52__tar.gz → 0.0.53__tar.gz

{rgwfuncs-0.0.52/src/rgwfuncs.egg-info → rgwfuncs-0.0.53}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.52
+Version: 0.0.53
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -370,17 +370,17 @@ Converts a polynomial expression written in Python syntax to a LaTeX formatted s
 
 Expands a polynomial expression written in Python syntax and converts it into a LaTeX formatted string. This function takes algebraic expressions provided as strings using Python's syntax, applies polynomial expansion through SymPy, and translates them into LaTeX representations, suitable for academic or professional documentation. It supports expressions with named variables and provides an option to substitute specific values into the expression before expansion.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The algebraic expression to expand and convert to LaTeX. This string should be formatted using Python syntax acceptable by SymPy.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers with which to substitute those variables before expanding.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string of the expanded expression.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors.
 
-- Example:
+• Example:
 
     from rgwfuncs import expand_polynomial_expression
 
@@ -406,17 +406,17 @@ Expands a polynomial expression written in Python syntax and converts it into a
 
 Factors a polynomial expression written in Python syntax and converts it into a LaTeX formatted string. This function parses an algebraic expression, performs polynomial factoring using SymPy, and converts the factored expression into a LaTeX representation, ideal for academic or professional use. Optional substitutions can be made before factoring.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The polynomial expression to factor and convert to LaTeX. This should be a valid expression formatted using Python syntax.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions. The keys are variable names in the expression, and the values are numbers that replace these variables.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string representing the factored expression.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors.
 
-- Example:
+• Example:
 
     from rgwfuncs import factor_polynomial_expression
 
@@ -441,7 +441,7 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 • Returns:
   - `str`: The simplified expression formatted as a LaTeX string.
 
-• Example Usage:
+• Example:
 
     from rgwfuncs import simplify_polynomial_expression
 
@@ -467,17 +467,17 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers to substitute.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
 
-- Example:
+• Example:
 
     from rgwfuncs import cancel_polynomial_expression
 
@@ -524,13 +524,14 @@ This function plots polynomial functions described by a list of expressions and
   - A value which is a dictionary containing substitutions for the expression. Must include an `"x"` key, either as `"*"` for default domain or a NumPy array.
 - `zoom` (`float`): Determines the numeric axis range from `-zoom` to `+zoom` for both x and y axes (default is `10.0`).
 - `show_legend` (`bool`): Specifies whether to include a legend in the plot (default is `True`).
+- `open_file` (`bool`): If saving to path is not desireable, opens the svg as a temp file, else opens the file from the actual location using the system's default viewer (defaults to False).
+- `save_path` (`Optional[str]`): If specified, saves the output string as a .svg at the indicated path (defaults to None).
 
 • Returns:
 - `str`: The raw SVG markup of the resulting plot.
 
 • Example:
 
-    import subprocess
     from rgwfuncs import plot_polynomial_functions
 
     # Generate the SVG
@@ -549,7 +550,7 @@ This function plots polynomial functions described by a list of expressions and
 
 • Displaying the SVG:
 
-![Plot](./media/plot_polynomial_functions_example_1.svg)
+    ![Plot](./media/plot_polynomial_functions_example_1.svg)
 
 --------------------------------------------------------------------------------
 

{rgwfuncs-0.0.52 → rgwfuncs-0.0.53}/README.md

@@ -343,17 +343,17 @@ Converts a polynomial expression written in Python syntax to a LaTeX formatted s
 
 Expands a polynomial expression written in Python syntax and converts it into a LaTeX formatted string. This function takes algebraic expressions provided as strings using Python's syntax, applies polynomial expansion through SymPy, and translates them into LaTeX representations, suitable for academic or professional documentation. It supports expressions with named variables and provides an option to substitute specific values into the expression before expansion.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The algebraic expression to expand and convert to LaTeX. This string should be formatted using Python syntax acceptable by SymPy.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers with which to substitute those variables before expanding.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string of the expanded expression.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors.
 
-- Example:
+• Example:
 
     from rgwfuncs import expand_polynomial_expression
 
@@ -379,17 +379,17 @@ Expands a polynomial expression written in Python syntax and converts it into a
 
 Factors a polynomial expression written in Python syntax and converts it into a LaTeX formatted string. This function parses an algebraic expression, performs polynomial factoring using SymPy, and converts the factored expression into a LaTeX representation, ideal for academic or professional use. Optional substitutions can be made before factoring.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The polynomial expression to factor and convert to LaTeX. This should be a valid expression formatted using Python syntax.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions. The keys are variable names in the expression, and the values are numbers that replace these variables.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string representing the factored expression.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors.
 
-- Example:
+• Example:
 
     from rgwfuncs import factor_polynomial_expression
 
@@ -414,7 +414,7 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 • Returns:
   - `str`: The simplified expression formatted as a LaTeX string.
 
-• Example Usage:
+• Example:
 
     from rgwfuncs import simplify_polynomial_expression
 
@@ -440,17 +440,17 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers to substitute.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
 
-- Example:
+• Example:
 
     from rgwfuncs import cancel_polynomial_expression
 
@@ -497,13 +497,14 @@ This function plots polynomial functions described by a list of expressions and
   - A value which is a dictionary containing substitutions for the expression. Must include an `"x"` key, either as `"*"` for default domain or a NumPy array.
 - `zoom` (`float`): Determines the numeric axis range from `-zoom` to `+zoom` for both x and y axes (default is `10.0`).
 - `show_legend` (`bool`): Specifies whether to include a legend in the plot (default is `True`).
+- `open_file` (`bool`): If saving to path is not desireable, opens the svg as a temp file, else opens the file from the actual location using the system's default viewer (defaults to False).
+- `save_path` (`Optional[str]`): If specified, saves the output string as a .svg at the indicated path (defaults to None).
 
 • Returns:
 - `str`: The raw SVG markup of the resulting plot.
 
 • Example:
 
-    import subprocess
     from rgwfuncs import plot_polynomial_functions
 
     # Generate the SVG
@@ -522,7 +523,7 @@ This function plots polynomial functions described by a list of expressions and
 
 • Displaying the SVG:
 
-![Plot](./media/plot_polynomial_functions_example_1.svg)
+    ![Plot](./media/plot_polynomial_functions_example_1.svg)
 
 --------------------------------------------------------------------------------
 

{rgwfuncs-0.0.52 → rgwfuncs-0.0.53}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rgwfuncs"
-version = "0.0.52"
+version = "0.0.53"
 authors = [
   { name = "Ryan Gerard Wilson", email = "ryangerardwilson@gmail.com" },
 ]

{rgwfuncs-0.0.52 → rgwfuncs-0.0.53}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = rgwfuncs
-version = 0.0.52
+version = 0.0.53
 author = Ryan Gerard Wilson
 author_email = ryangerardwilson@gmail.com
 description = A functional programming paradigm for mathematical modelling and data science

{rgwfuncs-0.0.52 → rgwfuncs-0.0.53}/src/rgwfuncs/algebra_lib.py

@@ -1,16 +1,15 @@
 import re
 import math
 import ast
+import subprocess
+import tempfile
 from sympy import symbols, latex, simplify, solve, diff, Expr, factor, cancel, Eq
 from sympy.core.sympify import SympifyError
 from sympy.core import S
 from sympy.parsing.sympy_parser import parse_expr
 from sympy import __all__ as sympy_functions
 from sympy.parsing.sympy_parser import (standard_transformations, implicit_multiplication_application)
-
 from typing import Tuple, List, Dict, Optional, Any
-
-
 import numpy as np
 import matplotlib.pyplot as plt
 from io import BytesIO
@@ -710,7 +709,9 @@ def solve_homogeneous_polynomial_expression(
 def plot_polynomial_functions(
     functions: List[Dict[str, Dict[str, Any]]],
     zoom: float = 10.0,
-    show_legend: bool = True
+    show_legend: bool = True,
+    open_file: bool = False,
+    save_path: Optional[str] = None,
 ) -> str:
     """
     Plots expressions described by a list of dictionaries of the form:
@@ -742,6 +743,13 @@ def plot_polynomial_functions(
         Sets the numeric axis range from -zoom..+zoom in both x and y.
     show_legend : bool
         Whether to add a legend to the plot (defaults to True).
+    open_file : bool
+        If saving to path is not desireable, opens the svg as a temp file, else opens
+        the file from the actual location using the system's default viewer (defaults to
+        False).
+    save_path : Optional[str]
+        If specified, saves the output string as a .svg at the indicated path (defaults to
+        None).
 
     Returns
     -------
@@ -771,6 +779,33 @@ def plot_polynomial_functions(
             # Fallback: just do naive **
             return expr_tmp.replace("**", "^")
 
+    def handle_open_and_save(
+        svg_string: str,
+        open_file: bool,
+        save_path: Optional[str]
+    ) -> None:
+        # Save the SVG to a file if a save path is provided
+        if save_path:
+            try:
+                with open(save_path, 'w', encoding='utf-8') as file:
+                    file.write(svg_string)
+                print(f"[INFO] SVG saved to: {save_path}")
+            except IOError as e:
+                print(f"[ERROR] Failed to save SVG to {save_path}. IOError: {e}")
+
+        # Handle opening the file if requested
+        if open_file and save_path:
+            result = subprocess.run(["xdg-open", save_path], stderr=subprocess.DEVNULL)
+            if result.returncode != 0:
+                print("[ERROR] Failed to open the SVG file with the default viewer.")
+        elif open_file:
+            with tempfile.NamedTemporaryFile(delete=False, suffix=".svg") as tmpfile:
+                temp_svg_path = tmpfile.name
+                tmpfile.write(svg_string.encode('utf-8'))
+            result = subprocess.run(["xdg-open", temp_svg_path], stderr=subprocess.DEVNULL)
+            if result.returncode != 0:
+                print("[ERROR] Failed to open the SVG file with the default viewer.")
+
     buffer = BytesIO()
     fig, ax = plt.subplots()
 
@@ -845,5 +880,8 @@ def plot_polynomial_functions(
         )
     else:
         plt.savefig(buffer, format='svg', bbox_inches='tight')
+
     plt.close(fig)
-    return buffer.getvalue().decode('utf-8')
+    svg_string = buffer.getvalue().decode('utf-8')
+    handle_open_and_save(svg_string, open_file, save_path)
+    return svg_string

{rgwfuncs-0.0.52 → rgwfuncs-0.0.53/src/rgwfuncs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.52
+Version: 0.0.53
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -370,17 +370,17 @@ Converts a polynomial expression written in Python syntax to a LaTeX formatted s
 
 Expands a polynomial expression written in Python syntax and converts it into a LaTeX formatted string. This function takes algebraic expressions provided as strings using Python's syntax, applies polynomial expansion through SymPy, and translates them into LaTeX representations, suitable for academic or professional documentation. It supports expressions with named variables and provides an option to substitute specific values into the expression before expansion.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The algebraic expression to expand and convert to LaTeX. This string should be formatted using Python syntax acceptable by SymPy.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers with which to substitute those variables before expanding.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string of the expanded expression.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors.
 
-- Example:
+• Example:
 
     from rgwfuncs import expand_polynomial_expression
 
@@ -406,17 +406,17 @@ Expands a polynomial expression written in Python syntax and converts it into a
 
 Factors a polynomial expression written in Python syntax and converts it into a LaTeX formatted string. This function parses an algebraic expression, performs polynomial factoring using SymPy, and converts the factored expression into a LaTeX representation, ideal for academic or professional use. Optional substitutions can be made before factoring.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The polynomial expression to factor and convert to LaTeX. This should be a valid expression formatted using Python syntax.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions. The keys are variable names in the expression, and the values are numbers that replace these variables.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string representing the factored expression.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors.
 
-- Example:
+• Example:
 
     from rgwfuncs import factor_polynomial_expression
 
@@ -441,7 +441,7 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 • Returns:
   - `str`: The simplified expression formatted as a LaTeX string.
 
-• Example Usage:
+• Example:
 
     from rgwfuncs import simplify_polynomial_expression
 
@@ -467,17 +467,17 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
 
-- Parameters:
+• Parameters:
   - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
   - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers to substitute.
 
-- Returns:
+• Returns:
   - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
 
-- Raises:
+• Raises:
   - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
 
-- Example:
+• Example:
 
     from rgwfuncs import cancel_polynomial_expression
 
@@ -524,13 +524,14 @@ This function plots polynomial functions described by a list of expressions and
   - A value which is a dictionary containing substitutions for the expression. Must include an `"x"` key, either as `"*"` for default domain or a NumPy array.
 - `zoom` (`float`): Determines the numeric axis range from `-zoom` to `+zoom` for both x and y axes (default is `10.0`).
 - `show_legend` (`bool`): Specifies whether to include a legend in the plot (default is `True`).
+- `open_file` (`bool`): If saving to path is not desireable, opens the svg as a temp file, else opens the file from the actual location using the system's default viewer (defaults to False).
+- `save_path` (`Optional[str]`): If specified, saves the output string as a .svg at the indicated path (defaults to None).
 
 • Returns:
 - `str`: The raw SVG markup of the resulting plot.
 
 • Example:
 
-    import subprocess
     from rgwfuncs import plot_polynomial_functions
 
     # Generate the SVG
@@ -549,7 +550,7 @@ This function plots polynomial functions described by a list of expressions and
 
 • Displaying the SVG:
 
-![Plot](./media/plot_polynomial_functions_example_1.svg)
+    ![Plot](./media/plot_polynomial_functions_example_1.svg)
 
 --------------------------------------------------------------------------------