Skip to content

Latest commit

 

History

History
43 lines (36 loc) · 1.94 KB

README.md

File metadata and controls

43 lines (36 loc) · 1.94 KB

aps-length

(c) James Kermode [email protected] 2014

Usage: aps-length [options] tex-files

Count number of equivalent words in an APS manuscript formatted in LaTeX, following guidelines described at http://journals.aps.org/authors/length-guide

Requires PyMuPDF to be installed (python3 -m pip install PyMuPDF) for pdf figures. Note that PyMuPDF is more accurate than gs and identify for pdf figures.

Requires detex (http://www.ctan.org/pkg/detex) and either ghostscript (http://www.ghostscript.com/) or ImageMagick identify (http://www.imagemagick.org) to be available on your path.

Use --figs=gs if you have .eps or .pdf figures, and --figs=identify if you have .png figures.

Options:
  -h, --help            show this help message and exit
  -v key value, --var=key value
                        Define TeX variables e.g. to specify location of
                        figure files.
  -e env1,env2,..., --env=env1,env2,...
                        Comma-separated list of LaTeX environments to ignore.
  -m (detex | wordcount), --method=(detex | wordcount)
                        Tool to use to count words in main text. Default is
                        wordcount, detex is also supported
                        (but tends to underestimate word count).
  -f (identify | gs), --figs=(identify | gs)
                        Tool to use to extract bounding box from figure.
                        Default is gs, ImageMagick identify also supported.
		    gs works with eps and pdf images, while
		    identify is a better choice for png images.
  --scale-figs=SCALE_FIGS
                        Scale estimate of figure word counts by factor,
                        default 1.1 (10%)
  -j PRL, --journal=PRL
                        Journal abbreviation (e.g. PRL, PRB-RC)
  -l LATEX, --latex=LATEX
                        Latex executable. Default is "pdflatex".