Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
arxiv_latex_cleaner: Clean the LaTeX code of your paper to submit to …
…arXiv. PiperOrigin-RevId: 228455932
- Loading branch information
1 parent
e11a6e0
commit d00a1af
Showing
18 changed files
with
1 addition
and
469 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1 @@ | ||
|
||
This tool allows you to easily clean the LaTeX code of your paper to submit to | ||
arXiv. From a folder containing all your code, e.g. `/path/to/latex/`, it | ||
creates a new folder `/path/to/latex_arXiv/`, that is ready to ZIP and upload to | ||
arXiv. | ||
|
||
## Example call: | ||
|
||
``` | ||
python -m arxiv_latex_cleaner.arxiv_latex_cleaner /path/to/latex/ --im_size 500 --images_whitelist='{"images/im.png":2000}' | ||
``` | ||
|
||
## Main features: | ||
|
||
#### Privacy-oriented | ||
|
||
* Removes all auxiliary files (`.aux`, `.log`, `.out`, etc.). | ||
* Removes all comments from your code (yes, those are visible on arXiv and you | ||
do not want them to be). | ||
|
||
#### Size-oriented | ||
|
||
There is a 10MB limit on arXiv submissions, so to make it fit: | ||
|
||
* Removes all unused images that take up space (those that are not actually | ||
included in any `.tex` file). | ||
* Resizes all images to `im_size` pixels, to reduce the size of the | ||
submission. You can whitelist some images to skip the global size using | ||
`images_whitelist`. | ||
|
||
## Usage: | ||
|
||
``` | ||
arxiv_latex_cleaner.py [-h] [--im_size IM_SIZE] | ||
[--images_whitelist IMAGES_WHITELIST] | ||
input_folder | ||
positional arguments: | ||
input_folder Input folder containing the LaTeX code. | ||
optional arguments: | ||
-h, --help show this help message and exit | ||
--im_size IM_SIZE Size of the output images (in pixels, longest side). | ||
Fine tune this to get as close to 10MB as possible. | ||
--images_whitelist IMAGES_WHITELIST | ||
Images that won't be resized to the default | ||
resolution, but the one provided here in a dictionary | ||
as follows '{"path/to/im.jpg": 1000}' | ||
``` | ||
This code has moved to [a new reposotory](https://github.com/google-research/arxiv-latex-cleaner). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.