3. Number Lines - automated

The LaTeX in this section is for one number line diagram.

The values in the diagram can be randomly generated by python.

3.1. Number line diagrams with answers

nl_plus_q

nl_plus_ans

nl_minus_neg_q

nl_minus_neg_ans

nl_minus_q

nl_minus_ans

nl_minus_pos_q

nl_minus_pos_ans

nl_plus_neg_q

nl_plus_neg_ans

nl_random_q

nl_random_ans

3.2. Splitting the LaTeX and modifying it to be built by python

The LaTeX from a single number lines equation is used as a starting point, split into 2 and modified.
The document template contains the preamble and the scaffold for the document.
The Diagram template contains the backtacking diagram LaTeX.

3.2.1. document template

The LaTeX number lines worksheet template is below.

document_template.tex

\documentclass[preview,12pt]{standalone}
\usepackage{tikz}
\usetikzlibrary{positioning}
\usetikzlibrary {arrows.meta}
\usetikzlibrary{bending}
\usepackage{ulem}
\usepackage[a4paper, portrait, margin=1cm]{geometry}

\def\jumpheight{10}
% % \def\qgap{\rule[-1pt]{1.0em}{.25pt}}
\def\qgap{\raisebox{-1pt}{\dotuline{\phantom{X}}}}


\begin{document}
    <<diagram>>
\end{document}

<<diagram>> is placeholder text for the text that python will use to add the LaTeX for the number line diagram.

3.2.2. diagram template

The LaTeX number line diagram template is below.

diagram_template.tex

\begin{tikzpicture}[scale=0.67]
    % axis, arrow style to-to
    \draw[{To[scale=1.3]}-{To[scale=1.3]}, line width=1pt] (-10.4, 0) -- (10.4, 0);
    % tick marks
    \foreach \x in {-10,-9,...,10}
        \draw[shift={(\x,0)},color=black, line width=1pt] (0pt,-14pt) -- (0pt,0pt);
    % numbers along each axis
    \foreach \x in {-10}
        \draw[shift={(\x -0.3,-0.8)},color=black] node[font=\large,text height=12pt] {$\x$};
    \foreach \x in {0,10}
        \draw[shift={(\x,-0.8)},color=black] node[font=\large,text height=12pt] {$\x$};
    % numbers for dots
    \draw[shift={(<<startval>>,-0.8)},color=black] node[font=\large,text height=12pt] {$<<startvaltxt>>$};
    \draw[shift={(<<endval>>,-0.8)},color=black] node[font=\large,text height=12pt] {$<<endvaltxt>>$};
    % dots
    \filldraw[black] (<<startval>>,0) circle (4pt) node[above,yshift=-2pt] (a) {};
    \filldraw[black] (<<endval>>,0) circle (4pt) node[above,yshift=-2pt] (b) {};
    % arrow
    \draw[-{To[scale=1.3, bend]},line width=1pt, color=black] (a.north)  .. controls  +(north:\jumpheight mm) and +(north:\jumpheight mm) .. node[above=2pt,xshift=-6pt,font=\large,text height=10pt] {$<<changevaltxt>>$} (b.north); % for addition
    % equation at right end
    \node [font=\large, anchor=east] at (15,1.65){$<<equtxt>>$};
\end{tikzpicture}

The line \draw[shift={(<<startval>>,-0.8)},color=black] node[font=\large,text height=12pt] {$<<startvaltxt>>$}; has a placeholder <<startval>> which is replaced by python.

Other placeholders are tagged by << >>.

3.2.3. Python to create a number line diagram

The Python to create a number line diagram is below.

This Python code is a script that generates a PDF file and PNG file with a number line diagram based on some random parameters. Here is an outline of the code:

It opens three template files for creating a tex file with a number line diagram and reads their contents.
It calls a function called make1_diagram that takes the diagram template text as an argument and returns two strings: one for the question and one for the answer. The function calls the btf.get_1step_process_dict function to get a dictionary with some keys and values for creating the diagram. The function then replaces the placeholders in the template text with the corresponding values from the dictionary, depending on whether it is for the answer or question version. The function uses a loop to iterate over the keys and values of the dictionary and perform the replacement.
It replaces a placeholder in the LaTeX template texts with the diagram texts and writes them to two output files: one for the question and one for the answer.
It waits for two seconds and then calls another function called convert_to_pdf that takes the output tex files and converts them to PDF files using the pdflatex command.
It waits for another second and then calls another function called convert_pdf_to_png from the magick_pdf_to_png module that takes the output PDF files and converts them to PNG files using the magick command.
It prints “starting” before calling the main function and “finished” after it.

Further details:

The code imports the modules pathlib, subprocess, time, random, and the file in the currectn directory magick_pdf_to_png.
The code defines the paths for the template and output files using the Path class from pathlib.
The code defines the function called btf.get_1step_process_dict that returns a dictionary with some keys and values for creating the number line diagram. The function uses a random integer to choose one of five possible cases, each corresponding to a different style of adding or subtracting numbers on the number line. The function calls another helper function called val_in_list_exclude_zero that returns a random integer from a range excluding zero.
The code defines the function called go_right_dict that takes an argument called add_style and returns a dictionary with some keys and values for creating a number line diagram where the arrow goes to the right. The function sets the end value, start value, and change value based on the argument and uses some formatting to display them as text.
The code defines a function called go_left_dict that takes an argument called sub_style and returns a dictionary with some keys and values for creating a number line diagram where the arrow goes to the left. The function sets the end value, start value, and change value based on the argument and uses some formatting to display them as text.
The code defines two lists called kv_keys_ans and kv_keys_q that contain the keys of the dictionary that are relevant for the answer and question versions of the diagram, respectively.
The code defines the function called trimkey that takes a key and removes the _q suffix if it has one.

number_lines_diagram_maker.py

from pathlib import Path
import subprocess
import os
import time
import random
import magick_pdf_to_png
import number_lines_functions as nlf


currfile_dir = Path(__file__).parent
tex_template_path = currfile_dir / "number_lines_template.tex"
texans_template_path = currfile_dir / "number_lines_template.tex"
tex_diagram_template_path = currfile_dir / "number_lines_diagram_template.tex"


def convert_to_pdf(tex_path, outputdir):
    tex_path = Path(tex_path).resolve()
    outputdir = Path(outputdir).resolve()
    # for testing
    # print(f"tex_path: {tex_path}")
    # print(f"outputdir: {outputdir}")
    try:
        # Generate the PDF
        subprocess.run(["latexmk", "-pdf", "-outdir=" + str(outputdir), str(tex_path)], check=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
        # # Clean auxiliary files after successful PDF generation
        subprocess.run(["latexmk", "-c", "-outdir=" + str(outputdir), str(tex_path)], check=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
        # for hosted remove stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL for debugging any errors
        # Remove the .tex file manually
        # if tex_path.exists():
        #     os.remove(tex_path)
    except subprocess.CalledProcessError as e:
        print(f"Error: {e}")



kv_keys_ans = ["startval", "endval", "startvaltxt", "endvaltxt", "changevaltxt", "equtxt"]
kv_keys_q = ["startval", "endval", "startvaltxt_q", "endvaltxt_q", "changevaltxt_q", "equtxt_q"]


def trimkey(key):
    key = key.replace("_q", "")
    return key


def make1_diagram(tex_diagram_template_txt, num):
    tex_diagram_template_txt_ans = tex_diagram_template_txt
    kv = nlf.getprocess_dict(num)
    for key, value in kv.items():
        # show answers
        if key in kv_keys_ans:
            tex_diagram_template_txt_ans = tex_diagram_template_txt_ans.replace("<<" + key + ">>", value)
    for key, value in kv.items():
        # don't show answers, use ___ for gaps
        if key in kv_keys_q:
            tex_diagram_template_txt = tex_diagram_template_txt.replace("<<" + trimkey(key) + ">>", value)
    return tex_diagram_template_txt, tex_diagram_template_txt_ans


def main():
    num = input("Enter 1,2,3,4,5 or 6 for plus,minus_neg,minus,minus_pos,plus_neg,random \n")
    if num.strip().isdigit():
        num = int(num)
        if not num in [1, 2, 3, 4, 5, 6]:
            num = 6  # random by default
    else:
        num = 6  # random by default
    filename = input("Enter the base filename to be added to the prefix nl_: \n")
    if not filename:
        filename = "1"  # "nl_1st_q and nl_1st_ans as default file"
    # set names of files that are made
    # questions
    # questions
    tex_output_path = currfile_dir / f"nl_{filename}_q.tex"
    pdf_path = currfile_dir / f"nl_{filename}_q.pdf"
    png_path = currfile_dir / f"nl_{filename}_q.png"

    # answers
    tex_output_path_ans = currfile_dir / f"nl_{filename}_ans.tex"
    pdf_path_ans = currfile_dir / f"nl_{filename}_ans.pdf"
    png_path_ans = currfile_dir / f"nl_{filename}_ans.png"
    # Read in the LaTeX template file
    with open(tex_template_path, "r") as infile:
        tex_template_txt = infile.read()
    # Read in the LaTeX template file for answers
    with open(texans_template_path, "r") as infile:
        tex_template_txt_ans = infile.read()
    # Read in the LaTeX diagram template file
    with open(tex_diagram_template_path, "r") as infile:
        tex_diagram_template_txt = infile.read()

    # Generate the <<diagram>> replacement tex
    diagram_text, diagram_text_ans = make1_diagram(tex_diagram_template_txt, num)
    # Replace the <<diagram>> placeholder in the LaTeX template
    tex_template_txt = tex_template_txt.replace("<<diagram>>", diagram_text)
    tex_template_txt_ans = tex_template_txt_ans.replace("<<diagram>>", diagram_text_ans)
    # Write the question diagram tex to an output file
    with open(tex_output_path, "w") as outfile:
        outfile.write(tex_template_txt)
    # Write the answer diagram tex to an output file
    with open(tex_output_path_ans, "w") as outfile:
        outfile.write(tex_template_txt_ans)

    # # Wait for the file to be created
    time.sleep(2)

    # convert to pdf
    convert_to_pdf(tex_output_path_ans, currfile_dir)
    convert_to_pdf(tex_output_path, currfile_dir)

    time.sleep(1)
    # convert to png
    magick_pdf_to_png.convert_pdf_to_png(pdf_path, png_path)
    magick_pdf_to_png.convert_pdf_to_png(pdf_path_ans, png_path_ans)


if __name__ == "__main__":
    print("starting")
    main()
    print("finished")