https://github.com/org-arl/jupyter-ieee-paper

Jupyter notebook to generate fully formatted IEEE papers
https://github.com/org-arl/jupyter-ieee-paper

ieee jupyter-notebook latex publication python

Last synced: 2 months ago
JSON representation

Jupyter notebook to generate fully formatted IEEE papers

• Host: GitHub
• URL: https://github.com/org-arl/jupyter-ieee-paper
• Owner: org-arl
• License: mit
• Created: 2018-06-12T12:29:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-10T15:28:57.000Z (over 6 years ago)
• Last Synced: 2024-04-15T00:17:28.550Z (10 months ago)
• Topics: ieee, jupyter-notebook, latex, publication, python
• Language: Jupyter Notebook
• Homepage:
• Size: 714 KB
• Stars: 32
• Watchers: 3
• Forks: 18
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jupyter notebook to generate IEEE papers

## Introduction

This is a simple template to demonstrate how fully formatted IEEE papers can directly be generated from Jupyter notebooks. Although not very sophisticated, it shows how most common requirements (e.g. title block, abstract, citations, section numbering & referencing, equations, equation numbering & referencing, figure numbering & referencing, etc) can be easily met.

## Quick start

To use this for your own papers, fork or clone this repository and edit the Jupyter notebook `paper.ipynb` and references `references.bib`. To generate the pdf version, simply open a terminal in the folder and type `make`. If everything goes well, you should have a `paper.pdf` generated in the folder.

If you need a single-column version for review, simply edit the metadata in the notebook and add `"options": "journal,onecolumn"` entry to the `latex_metadata` section.

## Dependencies

You will certainly need the following installed:

- Python 3

- Jupyter notebook

- LaTeX

The example template has the following additional dependencies:

- `arlpy`

- `selenium`

- `pillow`

- `phantomjs`

These allow high quality `bokeh` plots to be included in your paper. However, feel free to use `matplotlib` instead, if you prefer.

## Credits

The `ieee.tplx` template is adapted from work by [Julius Schulz and Alexander Schlaich](https://github.com/schlaicha/jupyter-publication-scripts).