Skip to main content

Inject Python calculations into Word and LaTeX documents with ease!

Project description

=====
docal
=====


.. image:: https://img.shields.io/pypi/v/docal.svg
:target: https://pypi.python.org/pypi/docal

.. image:: https://img.shields.io/travis/K1DV5/docal.svg
:target: https://travis-ci.org/K1DV5/docal

.. image:: https://readthedocs.org/projects/docal/badge/?version=latest
:target: https://docal.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status




Inject Python calculations into Word and LaTeX documents with ease!


* Free software: MIT license
* Documentation: https://docal.readthedocs.io.

doCal is a tool that can be used to send calculations that are written in
python to Word or LaTeX documents. It evaluates equations in a separate python
script from the document and replaces hashtags in the document that indicate
where the calculations should be with the results of the evaluation. It comes
with a powerful python expression to LaTeX converter built-in, so it converts
the calculations and their results to their appropriate LaTeX forms before
sending them, which makes it ideal to make academic and scientific reports.

Installation
============

Requirements
------------

**Quick note**: in this document, shell means ``cmd`` (command prompt) or
``powershell`` for Windows users and ``sh`` or ``bash`` for Linux and MacOS users.

A basic understanding of Python in general is necessary to have a smooth
experience here. If you want to work with a little more advanvced stuff, like
arrays and matrices, more knowledge about python is necessary.

It must be obvious by now but you should have Python installed on your system.
You can check that by opening your shell (see above) and typing the command
``python`` and hitting Enter. If it writes the version number and other info
about your python installation, you already have it installed. If the version
number starts with 2, you should probably install python 3 (the latest). If you
have python 3 or above, you\'re good to go. If either you don\'t have Python 3
or you don\'t have Python at all, you should go to `Python\'s homepage <https://www.python.org>`_ and install it, making sure to check the box
\"add python to path\" during installation.

If you want to work with word documents, you should have
`Pandoc <https://pandoc.org>` installed on your system (and in your path).
Because docal internally only works with tex files and when a word file is
given, it internally converts it to tex, modifies it and converts it back to
word, using pandoc.

Install
-------

To install this package, (after making sure that you have a working internet
connection) type the following command and hit Enter.

.. codeblock:: shell
pip install docal

Or if you have the source
.. codeblock:: shell
pip install .


Usage
=====

Typical workflow
----------------

- The user writes the static parts of the document as usual (Word or Latex) but
leaving sort of unique hashtags (\#tagname) for the calculation parts (double
hash signs for Wrod).
- The calculations are written on a separate text file with any text editor
(Notepad included) and saved next to the document file. For the syntax of the
calculation file, see below. But it\'s just a python script with comments.
- The tool is invoked with the following command:

.. codeblock:: shell
docal -s [calculation-file] -i [input-file] -o [output-file]

so for example,

.. codeblock:: shell
docal -s calcs.py -i document.tex -o document-out.tex

will be valid.
- Then voila! what is needed is done. The output file can be used normally.

Syntax
------

The syntax is simple. Just write the equations one line at a time. What you
write in the syntax is a valid python file, (it is just a script with a lot of
assignments and comments).

Comments that take whole lines
______________________________

These comments are converted to paragraphs or equations, depending on what
comes immediately after the hash sign. If the hash sign is followed by a
single dollar sign (\$), the rest of that line is expected to be a python
equation, and will be converted to an inline LaTeX equation. If what comes
after the dollar sign is two dollar signs, the rest of that line will be
converted to a displayed (block) equation in the document. Remember, these
equations are still in comments, and thus do not do anything except appear as
equations. If the hash sign is followed by just running text, it is converted
to a paragraph text. In all cases, when a hash character immediately followed
by a variable name like \#x, the value of that variable will be substituted at
that place. When a hash character immediately followed by an expression
surrounded by squirrely braces like \#{x + 2} is encountered, what is inside
the braces will be evaluated and substituted at that place.

Equations (python assignments)
______________________________

These are the main focus points of this module. Obviously, they are evaluated
as normal in the script so that the value of the variable can be reused as
always, but when they appear in the document, they are displayed as equation
blocks that can have up to three steps (that show the procedures). If it is a
simple assignment, like ``x = 10``, they appear only having a single step,
because there is no procedure to show. If the assignment contains something to
be evaluated but no variable reference like ``x = 10 + 5 / 2`` or if it contains
a single variable reference like ``x = x_prime`` then the procedure will have
only two steps, first the equation and second the results. If the equation has
both things to be evaluated and variable references, like ``x = 5*x_prime + 10``
then it will have three steps: the equation itself, the equation with variable
references substituted by their values, and the result. These equations can be
customized using comments at their ends (see below).

Comments after equations (assignments)
______________________________

These comments are taken to be customization options for the equations.
Multiple options can be separated by commas. The first option is units. if you
write something that looks like a unit (names or expressions of names) like
``N/m**2`` they are correctly displayed as units next to the result and whenever
that variable is referenced, next to its value. The next option is the display
type of the steps. If the option is a single dollar sign, the equation will be
inline and if it has more than a single step, the steps appear next to each
other. If it is double dollar signs, the equation(s) will be displayed as block
(centered) equations. Another option is step overrides. If it is a sequence of
digits like ``12``, then only the steps corresponding to that number will be
displayed (for this case steps 1 and 2). The last option is matrix and array
cut-off size. Matrices are cut off and displayed with dots in them if their
sizes are grester than 10 by 10 and arrays are cut off if they have more than
10 elements. To override this number, the option is the letter m followed by a
number like ``m6``. If the option starts with a hash sign like ``#this is a note``,
what follows will be a little note that will be displayed next to the last
step.

Comments that begin with double hash signs
______________________________

If you begin a comment line witn double hash signs, like ``## comment`` it is
taken as a real comment. It will not do anything.

Example
=======

Let's say you have a word document ``foo.docx`` with contents like this.

.. image:: https://github.com/K1DV5/doCal/raw/dev/common/images/word-in.jpg "Word document input"
:alt: Word document input

And you write the calculations in the file ``foo.py`` next to ``foo.docx``
.. codeblock:: python
## foo.py
## necessary for scientific functions
from math import *

#foo

# The first side of the first triangle is
x_1 = 5 #m
# and the second,
y_1 = 6 #m
# Therefore the length of the hypotenuse will be,
z_1 = sqrt(x_1**2 + y_1**2) #m

#bar

# Now the second triangle has sides that have lengths of
x_2 = 3
y_2 = 4
# and therefore has a hypotenuse of
z_2 = sqrt(x_2**2 + y_2**2) #m,13

# Then, we can say that the hypotenuse of the first triangle which is #z_1 long
# is longer than that of the second which is #z_2 long.

Now, If we run the command
.. codeblock:: shell
docal foo.py foo.docx

A third file, named ``foo-out.docx`` will appear. And it will look like this.

.. image:: https://github.com/K1DV5/doCal/raw/master/common/images/word-out.jpg "Word document output"
:alt: Word document output

Known Issues
============

- You cannot use python statements that need indenting. This is because docal
reads the script line by line and uses exec to make the necessary
assignments, and since you can't continue an already indented code with exec,
that will result in an error. If you have an idea to overcome this problem,
feel free to contact me.

- TODO: A nice GUI

Credits
-------

This package was created with Cookiecutter_ and the ``audreyr/cookiecutter-pypackage``_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _``audreyr/cookiecutter-pypackage``: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.4.0 (2019-02-08)
------------------

* First release on PyPI.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for docal, version 1.0.8
Filename, size File type Python version Upload date Hashes
Filename, size docal-1.0.8-py2.py3-none-any.whl (25.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size docal-1.0.8.tar.gz (32.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page