sympytex 0.3.3__tar.gz

sympytex-0.3.3/MANIFEST.in

@@ -0,0 +1,10 @@
+# The LaTeX sources and examples travel with the sdist so the package
+# can be rebuilt from its dtx source of truth.
+include sympytexpackage.dtx
+include sympytexpackage.ins
+include sympytex.sty
+include sympytex.py
+include Makefile
+include TODO
+include example.tex
+include gfplot_minimal.tex

sympytex-0.3.3/Makefile

@@ -0,0 +1,78 @@
+# Copyright (C) 2009-2014 by Tim Molteno <tim@physics.otago.ac.nz>
+#
+# This file may be redistributed and/or
+# modified under the terms of the GNU General Public License as
+# published by the Free Software Foundation, either version 2 of the
+# License, or (at your option) any later version. To view a copy of this
+# license, see http://www.gnu.org/licenses/ or send a letter to
+# the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA 02110-1301, USA.
+
+# To create everything necessary to use the SympyTeX package, type
+# 
+#      make all
+# and the files sympytex.sty and sympytex.py will be created
+# 
+# Requires makecmds.sty, for Debian-based distributions try
+#      aptitude install texlive-latex-extra python3-matplotlib
+#
+# SympyTeX requires Python 3, with sympy and matplotlib installed:
+#
+#	aptitude install python3 python3-sympy python3-matplotlib
+PYTHON=python3
+
+all: clean
+	latex sympytexpackage.ins
+
+docs:
+	rm -f *.sout
+	pdflatex -interaction=nonstopmode sympytexpackage.dtx
+	mkindex sympytexpackage.idx
+	${PYTHON} sympytexpackage.sympy
+	pdflatex -interaction=nonstopmode sympytexpackage.dtx
+
+# This builds the example document. The example uses matplotlib (aptitude install python3-matplotlib)
+test:
+	pdflatex -interaction=nonstopmode example.tex
+	${PYTHON} example.sympy
+	pdflatex -interaction=nonstopmode example.tex
+
+# Copy the docstrip-generated files into the installable Python package
+# in src/sympytex/. Run this after every change to sympytexpackage.dtx.
+sync-package: all
+	${PYTHON} tools/sync_package.py
+
+# Build the PyPI sdist and wheel (requires: pip install build).
+package: sync-package
+	${PYTHON} -m build
+
+ctan:	
+	cp README.md README
+	/home/tim/Downloads/ctan/scripts/ctanify/ctanify sympytexpackage.ins README sympytexpackage.pdf example.pdf
+	
+clean:
+	rm -f sympytex.* example.s* sympytexpackage.dvi sympytexpackage.aux
+	rm -rf sympy-plots-for-*
+
+dist:
+	tar -cf SympyTeX.tar sympytex.sty sympytex.py sympytexpackage.ins sympytexpackage.dtx example.tex README TODO Makefile
+	gzip -9 SympyTeX.tar
+
+DOCS=/usr/share/doc/latex-sympytex
+deb:	dist
+	rm -rf debian/usr
+	rm -rf debian/DEBIAN
+	mkdir -p debian/usr/share/texmf-texlive/tex/latex/sympytex
+	cp sympytex.sty debian/usr/share/texmf-texlive/tex/latex/sympytex 
+	mkdir -p debian/DEBIAN
+	cp debian/control debian/DEBIAN
+	mkdir -p debian${DOCS}
+	cp debian/copyright debian${DOCS}
+	cp example.tex debian${DOCS}
+	find ./debian -type d | xargs chmod 755
+	fakeroot dpkg-deb --build debian
+	mv debian.deb latex-sympytex_1.0-1_all.deb
+
+
+deb2: dist
+	dh_make -p latex-sympytex_1.0-1 -e tim@physics.otago.ac.nz -f SympyTeX.tar.gz

sympytex-0.3.3/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: sympytex
+Version: 0.3.3
+Summary: Embed sympy symbolic computation into LaTeX documents
+Author-email: Tim Molteno <tim@physics.otago.ac.nz>
+License-Expression: GPL-2.0-or-later
+Project-URL: Homepage, https://github.com/tmolteno/SympyTeX
+Project-URL: Documentation, https://github.com/tmolteno/SympyTeX#readme
+Keywords: latex,sympy,symbolic-math,typesetting
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: sympy>=1.1
+Provides-Extra: plots
+Requires-Dist: matplotlib; extra == "plots"
+
+This is the SympyTeX package. This package allows you to embed symbolic calculations
+and their results into LaTeX documents. SympyTex uses sympy, the symbolic python engine (http://www.sympy.org), to manipulate
+symbolic expressions. Using SympyTeX, sympy code can be embedded into your document, either hidden from view, or as part of the document, and
+sympy expressions can be rendered into LaTeX expressions and included in your document output.
+
+## Citing SympyTeX
+
+SympyTex was written by Tim Molteno (tim@physics.otago.ac.nz). The best way to cite
+sympytex is:
+
+
+Timothy C.A. Molteno, ''SympyTeX: Embedding symbolic computation into LaTeX
+documents'', Electronics Technical Reports No. 2014-1, ISSN 1172-496X, May 2014.
+
+====================================================================
+
+## Using SympyTex
+
+To use SympyTeX, you need the files, sympytex.sty and sympytex.py. These can be either in the current
+directory, or somewhere sensible on your system. See below for instructions on how to build these files.
+
+You also need to have installed the Sympy (Symbolic Python) package
+
+    aptitude install python3-sympy
+
+Create a LaTeX document (say mydoc.tex) that uses the sympytex package.
+
+    \usepackage{sympytex}
+
+    ...
+
+    \begin{sympyblock}
+    x = sympy.Symbol('x')
+    h = sympy.integrate(1+x**4,x)
+    \end{sympyblock}
+
+    The integral of $1+x^4$ is also \sympy{sympy.integrate(1+x**4,x)}.
+    or you can use a sympy variable, $h = \sympy{h}$
+
+Now run:
+
+    latex mydoc.tex
+    python3 mydoc.sympy
+    latex mydoc.tex
+
+See the include example.tex for more details.
+
+====================================================================
+
+## Installing from PyPI
+
+The Python half of SympyTeX is published on PyPI, so the `sympytex` module
+imported by the generated `.sympy` files can be installed with pip:
+
+    pip install sympytex
+
+This installs the module and a small `sympytex` command. The command can
+put `sympytex.sty` where LaTeX finds it, and run the sympy pass:
+
+    sympytex install             # copy sympytex.sty into TEXMFHOME
+    latex mydoc.tex
+    sympytex run mydoc.sympy     # same as: python3 mydoc.sympy
+    latex mydoc.tex
+
+If your documents plot matplotlib figures, install the plotting extra:
+
+    pip install "sympytex[plots]"
+
+The style file and the Python module carry their versions with them;
+if the two halves come from different sources and disagree, the sympy
+pass refuses to run and tells you which one to update (set the
+`SYMPYTEX_IGNORE_VERSION` environment variable to override).
+
+For developers, the package lives in `src/sympytex/` and is generated
+from this repository's dtx file (the single source of truth): run
+`make sync-package` after editing `sympytexpackage.dtx`, and
+`make package` to build the sdist and wheel.
+
+====================================================================
+
+## Building the Package
+
+### The easy way
+
+Use the provided Makefile
+
+    make 
+    make test
+
+This will build the SympyTeX package, and also create a sample document.
+
+### The hard way
+To build the SympyTeX package you will need to install some extra LaTeX
+packages (makecmds.sty)
+
+    aptitude install texlive-latex-extra
+
+Then do:
+
+  0. Run `latex sympytexpackage.ins'
+
+If a PDF file of the documentation wasn't included with this
+distribution of SympyTeX, you will need to build the documentation
+yourself. To do that:
+
+  1. Run `latex sympytexpackage.dtx'
+  2. Run `python3 sympytexpackage.sympy'
+  3. Run the indexing commands that the .ins file told you about.
+  4. Run `latex sympytexpackage.dtx' again.
+
+You can skip step 3 if you don't care about the index. You will need the
+pgf and tikz packages installed to typeset the figures.
+
+The file example.tex has, as you likely guessed, a bunch of examples
+showing you how this package works.
+
+## Building a debian package
+
+This is work-in-progress. But you should be able to build one using
+
+    make deb
+
+## Credits
+
+SympyTeX builds on a lot of work by others; in particular the work of
+Dan Drake <ddrake@member.ams.org> who created the sagetex package on which
+sympytex is based. See the "Credits" section
+of the documentation for credits. The source code may be modified and
+distributed under the terms of the GPL, v2 or later; the documentation
+may be modified and distributed under a Creative Commons Attribution -
+Noncommercial - Share Alike 3.0 License. See the "Copying and licenses"
+section of the documentation.
+
+Please let me know if you find any bugs or have any ideas for
+improvement!
+
+- Tim Molteno <tim@physics.otago.ac.nz>

sympytex-0.3.3/README.md

@@ -0,0 +1,137 @@
+This is the SympyTeX package. This package allows you to embed symbolic calculations
+and their results into LaTeX documents. SympyTex uses sympy, the symbolic python engine (http://www.sympy.org), to manipulate
+symbolic expressions. Using SympyTeX, sympy code can be embedded into your document, either hidden from view, or as part of the document, and
+sympy expressions can be rendered into LaTeX expressions and included in your document output.
+
+## Citing SympyTeX
+
+SympyTex was written by Tim Molteno (tim@physics.otago.ac.nz). The best way to cite
+sympytex is:
+
+
+Timothy C.A. Molteno, ''SympyTeX: Embedding symbolic computation into LaTeX
+documents'', Electronics Technical Reports No. 2014-1, ISSN 1172-496X, May 2014.
+
+====================================================================
+
+## Using SympyTex
+
+To use SympyTeX, you need the files, sympytex.sty and sympytex.py. These can be either in the current
+directory, or somewhere sensible on your system. See below for instructions on how to build these files.
+
+You also need to have installed the Sympy (Symbolic Python) package
+
+    aptitude install python3-sympy
+
+Create a LaTeX document (say mydoc.tex) that uses the sympytex package.
+
+    \usepackage{sympytex}
+
+    ...
+
+    \begin{sympyblock}
+    x = sympy.Symbol('x')
+    h = sympy.integrate(1+x**4,x)
+    \end{sympyblock}
+
+    The integral of $1+x^4$ is also \sympy{sympy.integrate(1+x**4,x)}.
+    or you can use a sympy variable, $h = \sympy{h}$
+
+Now run:
+
+    latex mydoc.tex
+    python3 mydoc.sympy
+    latex mydoc.tex
+
+See the include example.tex for more details.
+
+====================================================================
+
+## Installing from PyPI
+
+The Python half of SympyTeX is published on PyPI, so the `sympytex` module
+imported by the generated `.sympy` files can be installed with pip:
+
+    pip install sympytex
+
+This installs the module and a small `sympytex` command. The command can
+put `sympytex.sty` where LaTeX finds it, and run the sympy pass:
+
+    sympytex install             # copy sympytex.sty into TEXMFHOME
+    latex mydoc.tex
+    sympytex run mydoc.sympy     # same as: python3 mydoc.sympy
+    latex mydoc.tex
+
+If your documents plot matplotlib figures, install the plotting extra:
+
+    pip install "sympytex[plots]"
+
+The style file and the Python module carry their versions with them;
+if the two halves come from different sources and disagree, the sympy
+pass refuses to run and tells you which one to update (set the
+`SYMPYTEX_IGNORE_VERSION` environment variable to override).
+
+For developers, the package lives in `src/sympytex/` and is generated
+from this repository's dtx file (the single source of truth): run
+`make sync-package` after editing `sympytexpackage.dtx`, and
+`make package` to build the sdist and wheel.
+
+====================================================================
+
+## Building the Package
+
+### The easy way
+
+Use the provided Makefile
+
+    make 
+    make test
+
+This will build the SympyTeX package, and also create a sample document.
+
+### The hard way
+To build the SympyTeX package you will need to install some extra LaTeX
+packages (makecmds.sty)
+
+    aptitude install texlive-latex-extra
+
+Then do:
+
+  0. Run `latex sympytexpackage.ins'
+
+If a PDF file of the documentation wasn't included with this
+distribution of SympyTeX, you will need to build the documentation
+yourself. To do that:
+
+  1. Run `latex sympytexpackage.dtx'
+  2. Run `python3 sympytexpackage.sympy'
+  3. Run the indexing commands that the .ins file told you about.
+  4. Run `latex sympytexpackage.dtx' again.
+
+You can skip step 3 if you don't care about the index. You will need the
+pgf and tikz packages installed to typeset the figures.
+
+The file example.tex has, as you likely guessed, a bunch of examples
+showing you how this package works.
+
+## Building a debian package
+
+This is work-in-progress. But you should be able to build one using
+
+    make deb
+
+## Credits
+
+SympyTeX builds on a lot of work by others; in particular the work of
+Dan Drake <ddrake@member.ams.org> who created the sagetex package on which
+sympytex is based. See the "Credits" section
+of the documentation for credits. The source code may be modified and
+distributed under the terms of the GPL, v2 or later; the documentation
+may be modified and distributed under a Creative Commons Attribution -
+Noncommercial - Share Alike 3.0 License. See the "Copying and licenses"
+section of the documentation.
+
+Please let me know if you find any bugs or have any ideas for
+improvement!
+
+- Tim Molteno <tim@physics.otago.ac.nz>

sympytex-0.3.3/TODO

@@ -0,0 +1,3 @@
+TODO:
+
+* Incorporate new Latex printing commands from sympy 0.7

sympytex-0.3.3/example.tex

@@ -0,0 +1,110 @@
+% Copyright (C) 2009-2014 by Tim Molteno <tim@physics.otago.ac.nz>
+%
+% This file may be redistributed and/or
+% modified under the terms of the GNU General Public License as
+% published by the Free Software Foundation, either version 2 of the
+% License, or (at your option) any later version. To view a copy of this
+% license, see http://www.gnu.org/licenses/ or send a letter to
+% the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+% Boston, MA 02110-1301, USA.
+
+\documentclass{article}
+\usepackage{amsmath}
+\usepackage{amsfonts}
+\usepackage{amssymb}
+\usepackage{sympytex}
+
+\title{SympyTeX example}
+\author{Tim Molteno\thanks{tim@physics.otago.ac.nz}}
+
+
+\begin{document}
+
+\maketitle
+
+\section{Important! Setting up Your \LaTeX environment}
+
+To use SympyTeX, you have to run latex (or pdflatex) on your file, then python3, and then latex again. 
+\begin{verbatim}
+ latex example.tex
+ python3 example.sympy
+ latex example.tex
+\end{verbatim}
+If you use Kile, or another \LaTeX environment, you can set it up to automatically do the
+sympy python command as part of your build process.
+
+\section{Introduction}
+
+Using sympy within your \LaTeX document is as easy as $2+2=\sympy{2+2}$. 
+
+You can write a block, and then use the variables defined later in your code!
+\begin{sympyblock}
+x = sympy.Symbol('x')
+h = sympy.integrate(1+x,x)
+\end{sympyblock}
+The variable $h$, can now be called using {\verb!\sympy{h}!}, and you will get $h = \sympy{h}$. 
+Similarly, the integral of $1+x^4$ is $\sympy{sympy.integrate(1+x**4,x)}$.
+
+\section{sympyplain}
+
+The sympyplain command places the sympy output as text (rather than LaTeX formatted math stuff). 
+This is really useful if the output is huge as formulae don't line wrap.
+
+The integral of $1+x^4$ is also \sympyplain{sympy.integrate(1+x**4,x)}.
+
+\begin{sympyblock}
+from sympy import *
+e = 1/cos(x)
+\end{sympyblock}
+The series expansion is $\sympy{e.series(x, 0, 10)}$.
+
+\subsection{Invisibly sympy code}
+
+Placing a {\tt sympysilent} block in your code, allows you do do things like define
+symbols without making a mess.
+\begin{sympysilent}
+theta = sympy.Symbol('theta')
+from sympy import *
+def RotationMatrixZ(angle):
+  return Matrix([[cos(angle), -sin(angle), 0],[sin(angle), cos(angle),0],[0,0,1]])
+\end{sympysilent}
+The rotation matrix is through an angle $\theta$ around the $z$-axis is
+\[ R(\theta) = \sympy{RotationMatrixZ(theta)}. \]
+
+\section{Plotting}
+
+Plotting works using the {\tt sympyplot} command. This takes a matplotlib figure as a parameter. Have a look at the example below.
+\begin{sympyblock}
+import matplotlib
+import matplotlib.pyplot as plt
+plt.matplotlib.rc('text', usetex = True)
+import pylab
+import numpy as np
+fig = plt.figure()
+ax = fig.add_subplot(111)
+t = pylab.linspace(0,10,400)
+ax.plot(t, np.sin(t*3), '-',
+        t, np.sin(0.3*t**2), '--',
+        t, np.cos(t), '-.')
+ax.legend((r'$A^{\omega}$', r'$A^{2\omega}$', r'$A^{3\omega}$'),
+    shadow = False, loc = (0.75, 0.1))
+ax.set_xlabel(r'$\gamma_1 + \gamma_2$', {'fontsize'   : 20 })
+ax.set_ylabel(r'$A^{n\omega}$ (dB)', {'fontsize'   : 20 })
+\end{sympyblock}
+Here we're using matplotlib! So this sympytex package is really not quite named properly.
+
+\begin{figure}
+\sympyplot[width=\linewidth]{fig}
+\caption{The graph generated from {\tt \textbackslash sympyplot[width=\textbackslash linewidth]\{fig\}} }
+\end{figure}
+
+The syntax is
+{\verb! \sympyplot[<includegraphics opts>][fmt]{figure} !}
+where:
+\begin{itemize}
+\item {\verb!fmt!} can be one of pdf,eps,png,jpg or many more. If it is omitted, then an appropriate choice will be made for you.
+\item {\verb!<figure>!} is a matplotlib figure object 
+\end{itemize}
+ 
+
+\end{document}

sympytex-0.3.3/gfplot_minimal.tex

@@ -0,0 +1,45 @@
+\documentclass{article}
+\usepackage{amsmath}
+\usepackage{amsfonts}
+\usepackage{amssymb}
+\usepackage{sympytex}
+
+\usepackage{pgfplots}
+
+\title{SympyTeX pgfplots example}
+\author{Alexander Steppke}
+
+\begin{document}
+
+\maketitle
+
+\section{Plotting with PGF/TikZ in SympyTeX}
+To plot figures with SympyTeX besides the python matplotlib alternatively the LaTeX package pgfplots can be used. Pgfplots is using the PGF/TikZ package as a graphics backend. The main advantages are the fast output, as we do not need to create any external files and the good integration of pgfplots into LaTeX. A short example is given below.
+
+\begin{sympyblock}
+from numpy import linspace, sin
+time = linspace(0,6,200)
+values = sin(3*time)
+coordinates = ""
+for t, v in zip(time, values):
+  coordinates = coordinates + '({:.5f}, {:.5f}) '.format(t, v)
+
+pgfplot = r"""
+\begin{tikzpicture}
+  \begin{axis}[xlabel=Time,ylabel=Amplitude]
+    \addplot[color=red,mark=x] coordinates { %s };
+  \end{axis}
+\end{tikzpicture}
+""" % (coordinates)
+
+\end{sympyblock}
+
+After calculating the datapoints we insert them into the string {\verb!pgfplot!} and output the string into our LaTeX document using {\verb!\sympyplain{pgfplot}!} in a figure environment.
+\begin{figure}
+  \centering
+  \sympyplain{pgfplot}
+  \caption{A simple plot with SympyTeX and pgfplots.}
+\end{figure}
+
+
+\end{document}

sympytex-0.3.3/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sympytex"
+description = "Embed sympy symbolic computation into LaTeX documents"
+readme = "README.md"
+license = "GPL-2.0-or-later"
+requires-python = ">=3.9"
+authors = [{name = "Tim Molteno", email = "tim@physics.otago.ac.nz"}]
+keywords = ["latex", "sympy", "symbolic-math", "typesetting"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Science/Research",
+  "Programming Language :: Python :: 3",
+  "Topic :: Scientific/Engineering :: Mathematics",
+  "Topic :: Text Processing :: Markup :: LaTeX",
+]
+dependencies = ["sympy>=1.1"]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+plots = ["matplotlib"]
+
+[project.scripts]
+sympytex = "sympytex.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/tmolteno/SympyTeX"
+Documentation = "https://github.com/tmolteno/SympyTeX#readme"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+sympytex = ["data/*.sty"]
+
+[tool.setuptools.dynamic]
+version = {attr = "sympytex.__version__"}

sympytex-0.3.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+