prefig 0.2.15.dev20250514053750__py3-none-any.whl → 0.5.6.dev20260130060411__py3-none-any.whl

prefig/cli.py

@@ -79,12 +79,17 @@ def init():
     # on Windows and linux
     wd = os.getcwd()
     os.chdir(destination)
-    log.info(f"Installing MathJax libraries in {destination}")
-    try:
-        subprocess.run(["npm", "install"]) #, f"--prefix={destination}"])
-    except:
-        log.warning("MathJax installation failed.  Is npm installed on your system?")
-        log.setLevel(log_level)
+
+    npm_cmd = shutil.which("npm")
+    if npm_cmd is None:
+        log.error("Cannot find npm to install MathJax for PreFigure")
+    else:
+        log.info(f"Installing MathJax libraries in {destination}")
+        try:
+            subprocess.run([npm_cmd, "install"]) #, f"--prefix={destination}"])
+        except:
+            log.warning("MathJax installation failed.  Is npm installed on your system?")
+            log.setLevel(log_level)
     os.chdir(wd)
 
     log.info("Installing the Braille29 font")
@@ -347,21 +352,6 @@ def view(filename, ignore_annotations, port):
             diagcess_dir = dir
             break
 
-    # if we didn't find the diagcess tools, we'll install them here
-    if diagcess_dir is None:
-        prefig_root = Path(__file__).parent
-        source = prefig_root / 'resources' / 'diagcess'
-        cwd = Path(os.getcwd())
-    
-        shutil.copytree(
-            source,
-            cwd,
-            dirs_exist_ok = True
-        )
-        diagcess_dir = cwd
-
-    diagcess_file = diagcess_dir / 'diagcess.html'
-
     # Now we'll look for the output SVG file to view
     # If we're given an xml file, we'll modify the filename
     if filename.endswith('.xml'):
@@ -378,12 +368,26 @@ def view(filename, ignore_annotations, port):
         log.warning(f"There is no directory {path.parent}")
         return
 
-    for dir, dirs, files in os.walk(os.getcwd()):
-        files = set(files)
-        if path.name in files:
-            view_path = path.parent / dir / path.name
+    # we're going to look for file to view in the current directory first
+    cwd_files = os.listdir('.')
+    if path.name in cwd_files:
+        view_path = path.parent / path.name
+    else:
+        # now we'll look in output
+        if 'output' in cwd_files:
+            cwd_files = os.listdir('output')
+            if path.name in cwd_files:
+                view_path = path.parent / 'output' / path.name
+
+    # if we still didn't find it, descend the file structure
+    if view_path is None:
+        for dir, dirs, files in os.walk(os.getcwd()):
+            files = set(files)
+            if path.name in files:
+                view_path = path.parent / dir / path.name
+
     if view_path is None:
-        log.warning(f'Unable to find {filename}')
+        log.error(f'Unable to find {filename}')
         return
 
     # We are going to start the server from the home directory
@@ -416,6 +420,22 @@ def view(filename, ignore_annotations, port):
         webbrowser.open(url)
     else:
         # There are annotations so we'll open with diagcess
+
+        # if we didn't find the diagcess tools, we'll install them here
+        if diagcess_dir is None:
+            prefig_root = Path(__file__).parent
+            source = prefig_root / 'resources' / 'diagcess'
+            cwd = Path(os.getcwd())
+
+            shutil.copytree(
+                source,
+                cwd,
+                dirs_exist_ok = True
+            )
+            diagcess_dir = cwd
+
+        diagcess_file = diagcess_dir / 'diagcess.html'
+
         file_rel_path = os.path.relpath(view_path, diagcess_dir)
         file_rel_path = file_rel_path[:-4]
         diagcess_rel_path = os.path.relpath(diagcess_file, home_dir)

prefig/core/CTM.py

@@ -71,6 +71,10 @@ class CTM:
         else:
             self.ctm = ctm
         self.ctm_stack = []
+        self.scale_x = lambda x: x
+        self.scale_y = lambda y: y
+        self.inv_scale_x = lambda x: x
+        self.inv_scale_y = lambda y: y
 
     def push(self):
         self.ctm_stack.append([self.ctm, self.inverse])
@@ -81,6 +85,14 @@ class CTM:
             return
         self.ctm, self.inverse = self.ctm_stack.pop(-1)
 
+    def set_log_x(self):
+        self.scale_x = lambda x: np.log10(x)
+        self.inv_scale_x = lambda x: 10**x
+
+    def set_log_y(self):
+        self.scale_y = lambda y: np.log10(y)
+        self.inv_scale_y = lambda y: 10**y
+
     def translate(self, x, y):
         m = translation(x, y)
         self.ctm = concat(self.ctm, m)
@@ -111,12 +123,15 @@ class CTM:
     def inverse_transform(self, p):
         p = list(p).copy()
         p.append(1)
-        return np.array([math_util.dot(self.inverse[i], p) for i in range(2)])
+        inv_point = [math_util.dot(self.inverse[i], p) for i in range(2)]
+        return np.array([self.inv_scale_x(inv_point[0]),
+                         self.inv_scale_y(inv_point[1])])
 
     def transform(self, p):
-        p = list(p).copy()
+        p = [self.scale_x(p[0]), self.scale_y(p[1])]
         p.append(1)
-        return np.array([math_util.dot(self.ctm[i], p) for i in range(2)])
+        transformed_point = [math_util.dot(self.ctm[i], p) for i in range(2)]
+        return np.array(transformed_point)
 
     def copy(self):
         return copy.deepcopy(self) # CTM(copy.deepcopy(self.ctm))

prefig/core/__init__.py

@@ -2,6 +2,7 @@ from . import (
     annotations,
     area,
     arrow,
+    axes,
     calculus,
     circle,
     clip,
@@ -12,6 +13,7 @@ from . import (
     graph,
     grid_axes,
     group,
+    image,
     implicit,
     label,
     label_tools,

prefig/core/annotations.py

@@ -1,5 +1,6 @@
 import lxml.etree as ET
 import logging
+import copy
 
 log = logging.getLogger('prefigure')
 
@@ -32,14 +33,20 @@ def annotate(element, diagram, parent = None):
         parent = diagram.get_annotations_root()
 
     if element.get('ref', None) is not None:
-        element.set('id', element.get('ref'))
+        ref = element.get('ref')
+        if not ref.startswith('pf__'):
+            ref = 'pf__' + ref
+        element.set('id', ref)
         element.attrib.pop('ref')
     else:
         log.info(f"An annotation has an empty attribute ref")
     element.attrib.pop('annotate', None)
 
     # let's check to see if this is a reference to an annotation branch
-    annotation = diagram.get_annotation_branch(element.get('id'))
+    id = element.get('id')
+    if not id.startswith('pf__'):
+        id = 'pf__' + id
+    annotation = diagram.get_annotation_branch(id)
     if annotation is not None:
         annotate(annotation, diagram, parent)
         return
@@ -122,3 +129,109 @@ def annotate(element, diagram, parent = None):
         ACTIVE = ET.Element('ACTIVE')
         ACTIVE.text = element.get('id')
         sonification.append(ACTIVE)
+
+pronounciations = {
+    'de-solve': 'D E solve',
+    'define-shapes': 'define shapes',
+    'angle-marker': 'angle marker',
+    'area-between-curves': 'area between curves',
+    'area-under-curve': 'area under curve',
+    'grid-axes': 'grid axes',
+    'implicit-curve': 'implicit curve',
+    'parametric-curve': 'parametric curve',
+    'plot-de-solution': 'plot D E solution',
+    'riemann-sum': 'Riemann sum',
+    'slope-field': 'slope field',
+    'tick-mark': 'tick mark',
+    'tangent-line': 'tangent line',
+    'vector-field': 'vector field'
+}
+
+labeled_elements = {
+    'label',
+    'point',
+    'xlabel',
+    'ylabel',
+    'angle-marker',
+    'tick-mark',
+    'item',
+    'node',
+    'edge'
+}
+
+label_subelements = {
+    'm': 'math',
+    'b': 'bold',
+    'it': 'italics',
+    'plain': 'plain',
+    'newline': 'new line'
+}
+
+def diagram_to_speech(diagram):
+    diagram = copy.deepcopy(diagram)
+
+    element_num = 0
+    for element in diagram.getiterator():
+        if element.tag in label_subelements.keys():
+            element.getparent().remove(element)
+            continue
+        attribs = copy.deepcopy(element.attrib)
+        for attrib_name in list(element.attrib.keys()):
+            element.attrib.pop(attrib_name)
+
+        if element.tag == "diagram":
+            element.set('ref', 'figure')
+            intro = "This prefigure source file begins with a diagram having these attributes: "
+        elif element.tag == "definition":
+            element.set('ref', 'element-'+str(element_num))
+            tag_speech = 'definition'
+            intro = "A definition element defining " + element.text.strip()
+        elif element.tag in labeled_elements:
+            element.set('ref', 'element-'+str(element_num))
+            tag_speech = pronounciations.get(element.tag, element.tag)
+            label_text = label_to_speech(element)
+            if len(label_text) > 0:
+                if len(attribs) == 0:
+                    intro = f"A {tag_speech} element with label {label_text}.  The element has no attributes."
+                else:
+                    intro = f"A {tag_speech} element with label {label_text}.  There are these attributes: "
+            else:
+                if len(attribs) == 0:
+                    intro = f"A {tag_speech} element with no attributes."
+                else:
+                    intro = f"A {tag_speech} element with these attributes: "
+            element.text = None
+        else:
+            element.set('ref', 'element-'+str(element_num))
+            tag_speech = pronounciations.get(element.tag, element.tag)
+            if len(attribs) == 0:
+                intro = f"A {tag_speech} element with no attributes"
+            else:
+                intro = f"A {tag_speech} element with these attributes: "
+        element.set("text", intro + attributes_to_speech(attribs))
+        element_num += 1
+        element.tag = "annotation"
+
+    log.error(ET.tostring(diagram, pretty_print=True))
+    return diagram
+
+def attributes_to_speech(attribs):
+    strings = []
+    for key, value in attribs.items():
+        strings.append(f"{key} has value {value}")
+    return ', '.join(strings)
+
+def label_to_speech(element):
+    strings = []
+    if (element.text is not None and
+        len(element.text.strip()) > 0):
+        strings.append(element.text.strip())
+    for child in element:
+        child_speech = label_subelements.get(child.tag, child.tag)
+        strings.append('begin ' + child_speech)
+        strings.append(child.text.strip())
+        strings.append('end ' + child_speech)
+        if (child.tail is not None and
+            child.tail.strip() is not None):
+            strings.append(child.tail.strip())
+    return ' '.join(strings)

prefig/core/area.py

@@ -2,6 +2,7 @@
 
 import lxml.etree as ET
 import logging
+import math
 from . import user_namespace as un
 from . import utilities as util
 
@@ -13,6 +14,7 @@ def area_between_curves(element, diagram, parent, outline_status):
         finish_outline(element, diagram, parent)
         return
 
+    polar = element.get('coordinates', 'cartesian') == 'polar'
     util.set_attr(element, 'stroke', 'black')
     util.set_attr(element, 'fill', 'lightgray')
     util.set_attr(element, 'thickness', '2')
@@ -53,17 +55,32 @@ def area_between_curves(element, diagram, parent, outline_status):
     else:
         domain = un.valid_eval(domain)
 
+    if element.get('domain-degrees', 'no') == 'yes':
+        domain = [math.radians(d) for d in domain]
+
     dx = (domain[1]-domain[0])/N
     x = domain[0]
-    p = diagram.transform((x, f(x)))
+    if polar:
+        r = f(x)
+        p = diagram.transform((r*math.cos(x), r*math.sin(x)))
+    else:
+        p = diagram.transform((x, f(x)))
     cmds = ['M ' + util.pt2str(p)]  
     for _ in range(N+1):
-        p = diagram.transform((x,f(x)))
+        if polar:
+            r = f(x)
+            p = diagram.transform((r*math.cos(x), r*math.sin(x)))
+        else:
+            p = diagram.transform((x, f(x)))
         cmds.append('L ' + util.pt2str(p))
         x += dx
     for _ in range(N+1):
         x -= dx
-        p = diagram.transform((x, g(x)))
+        if polar:
+            r = g(x)
+            p = diagram.transform((r*math.cos(x), r*math.sin(x)))
+        else:
+            p = diagram.transform((x, g(x)))
         cmds.append('L ' + util.pt2str(p))
     cmds.append('Z')
     d = ' '.join(cmds)
@@ -72,7 +89,6 @@ def area_between_curves(element, diagram, parent, outline_status):
     diagram.add_id(path, element.get('id'))
     path.set('d', d)
     util.add_attr(path, util.get_2d_attr(element))
-#    path.set('type', 'area between curves')
 
     if outline_status == 'add_outline':
         diagram.add_outline(element, path, parent)

prefig/core/arrow.py

@@ -5,6 +5,7 @@ import numpy as np
 from . import utilities as util
 from . import CTM
 from . import user_namespace as un
+from . import repeat
 
 log = logging.getLogger('prefigure')
 
@@ -21,7 +22,7 @@ def add_tactile_arrowhead_marker(diagram, path, mid=False):
     # get the stroke width from the graphical component
     stroke_width_str = path.get('stroke-width', '1')
     stroke_width = int(stroke_width_str)
-    id = 'arrow-head-'+stroke_width_str
+    id = 'pf__arrow-head-'+stroke_width_str
 
     # if we've seen this already, there's no need to create it again
     if diagram.has_reusable(id):
@@ -179,16 +180,21 @@ def add_arrowhead_marker(diagram,
     # end or in the middle of a path
     id_data = f"_{arrow_width}_{arrow_angles[0]}_{arrow_angles[1]}"
     if not mid:
-        id = 'arrow-head-end-'+stroke_width_str+id_data+'-'+stroke_color
+        id = 'pf__arrow-head-end-'+stroke_width_str+id_data+'-'+stroke_color
         if arrow_width is None:
             arrow_width = 4
         dims = (1, arrow_width)
     else:
-        id = 'arrow-head-mid-'+stroke_width_str+id_data+'-'+stroke_color
+        id = 'pf__arrow-head-mid-'+stroke_width_str+id_data+'-'+stroke_color
         if arrow_width is None:
             arrow_width = 13/3
         dims = (1, arrow_width) #11/3)
 
+    # EPUB does not allow some characters to appear in @id
+    # There is a possibility that we have # or . so we will
+    # replace them with this function call
+    id = repeat.epub_clean(id)
+
     # If we've already created this one, we'll just move on
     if diagram.has_reusable(id):
         return id