Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/giovannibordiga/latex-subfigs-combiner

Python script for combining LaTeX figures composed of subfigures
https://github.com/giovannibordiga/latex-subfigs-combiner

latex latex-figure latex-submissions python-script subfigures

Last synced: 26 days ago
JSON representation

Python script for combining LaTeX figures composed of subfigures

Awesome Lists containing this project

README 

        
# LaTeX Subfigs Combiner



![Made with Python](https://img.shields.io/badge/Made%20with-Python-blue?logo=python&logoColor=ecf0f1&labelColor=34495e)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/latex-subfigs-combiner?labelColor=34495e)

[![PyPI](https://img.shields.io/pypi/v/latex-subfigs-combiner?labelColor=34495e)](https://pypi.org/project/latex-subfigs-combiner "Go to PyPI")

![PyPI - Wheel](https://img.shields.io/pypi/wheel/latex-subfigs-combiner?labelColor=34495e)

[![GitHub license](https://img.shields.io/github/license/GiovanniBordiga/latex-subfigs-combiner?labelColor=34495e)](https://github.com/GiovanniBordiga/latex-subfigs-combiner/blob/master/LICENSE)

[![Tip me](https://img.shields.io/badge/Tip%20me-a%20beer-16a085?labelColor=34495e)](http://deadcat.epizy.com/ "Send tip via LN")

[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FGiovanniBordiga%2Flatex-subfigs-combiner&count_bg=%2327AE60&title_bg=%2334495E&icon=github.svg&icon_color=%23E7E7E7&title=Hits&edge_flat=false)](https://hits.seeyoufarm.com)



Python script for combining LaTeX figures composed of subfigures



---



## What



This package provides a simple Python script for combining LaTeX figures composed of subfigures into single PDF files, i.e. one PDF per composite figure.



## Why



If you have ever tried to publish on scientific journals, you have probably encountered at least _one_ journal that either does not accept LaTeX [`subfigures`](https://www.ctan.org/pkg/subcaption) or will combine your composite figures during production with a very high chance of making a mess (both scenarios are completely unreasonable, but yet they happen sometimes).

Of course, you really like those shiny composite LaTeX figures and do not want to waste time painstakingly stitching them together by hand (e.g. using Inkscape).

This Python script provides an hands-free automated solution to this problem.



## How



The job is done by parsing the given TeX file, extracting the preamble, setting the page style to empty, extracting the `figure` environments that contain `subfigures`, compiling to a PDF via [`latexmk`](https://www.ctan.org/pkg/latexmk/), and then crop each figure to a separate PDF file using [`pdfcrop`](https://www.ctan.org/pkg/pdfcrop).



---



## Installation



Easy peasy via `pip` or equivalent



```bash

pip install latex-subfigs-combiner

```



## Usage



In a terminal, simply run `combine-subfigs` on your LaTeX main file



```bash

combine-subfigs /path/to/my/awesome/paper.tex

```



This will produce all the composite figures in a directory named `composite-figures` at the location you called the script from.



By default, the output figures will be named as `fig_1.pdf`, `fig_2.pdf`, etc.

If you want to change the output directory or the filename prefix `fig_` of the figures, you can use the optional arguments `--target_dir` and `--prefix`, respectively.

Execute `combine-subfigs -h` for more details.



---



## Tips are welcomed! :love_you_gesture:



If you found this useful, feel free to offer me a beer :beer: via [PayPal](https://paypal.me/GiovanniBordiga/3 "Send tip via PayPal") or [send me a few sats](http://deadcat.epizy.com/ "Send tip via LN") :zap:.