Skip to content
LaTeX template class for Quantum - the open journal for quantum science
Branch: master
Clone or download
Latest commit c667daa Jul 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitattributes Project created Nov 16, 2016
.gitignore added quantum-lyx-template.pdf to ignored files Jun 28, 2019
.travis.yml copy example-plot.pdf to _build to fix unit tests Jun 4, 2019
README.md Final fixes in readme Jul 11, 2019
example-plot.pdf Added a real example plot and a description of the quantum-plots note… Mar 13, 2019
install.ps1 Adjust CTAN packaging in install.ps1 May 22, 2019
install.sh fixed mode of install.sh Apr 6, 2019
quantum-lyx-template.lyx ported changes from #99 to lyx layout Jul 9, 2019
quantum-plots.ipynb Replace support email address with link to GitHub issue tracker May 17, 2019
quantum-plots.mplstyle Update quantum-plots.mplstyle Apr 1, 2019
quantum-template.pdf updated release date and recompiled pdfs Jul 11, 2019
quantum-template.tex
quantumarticle.cls updated release date and recompiled pdfs Jul 11, 2019
quantumarticle.layout Removed \nopdfoutputerror flag Jun 12, 2019
quantumarticle.pdf updated release date and recompiled pdfs Jul 11, 2019
quantumarticle.tex Fix typos in documentation Jul 2, 2019

README.md

Build Status

LaTeX document class for Quantum

This is version 5.0 of quantumarticle, the document class for typesetting articles in Quantum - the open journal for quantum science.

Click here to download the latest stable version.

More information on using quantumarticle and on typesetting manuscripts for Quantum can be found in the accompanying template.

Documentation of all class options is also provided.

Installation and usage

To use the quantumarticle document class with LaTeX simply start your document with the line:

\documentclass[your options]{quantumarticle}

Before you can do this however, you must make quantumarticle.cls accessible to your LaTeX compiler. You have several options for doing this:

  1. The quantumarticle class is provided with install scripts for bash and PowerShell. These scripts should work for Windows 7 or later with MiKTeX, or for TeX Live with Linux or macOS / OS X. To install the class into your user-local LaTeX directory you would first clone this git repository git clone https://github.com/quantum-journal/quantum-journal.git quantum-journal and them from within bash execute:
$ cd quantum-journal/
$ ./install.sh

Similarly, under PowerShell:

PS > cd quantum-journal/
PS > ./install.ps1
  1. Alternatively you can use quantumarticle.cls without installing it by simply downloading it directly via this link and putting it in the same folder as your main LaTeX source file. This can be the most convenient option if you are working on a manuscript together with collaborators that do not want to install quantumarticle.cls and are exchanging the source files of your manuscript via email or cloud storage services. When you upload your manuscript to the arXiv you will anyway have to include quantumarticle.cls along with other source files.

  2. To manually install quantumarticle, you can either clone this git repository or download quantumarticle.cls directly via this link and then copy the quantumarticle.cls file to texmf/tex/latex/quantumarticle within your home directory (under Linux, macOS, and OS X ~/, or under Windows typically C:\Users\[your username]) and run texhash (TeX Live) or initexmf --update-fndb (MiKTeX).

  3. Finally, you can use quantumarticle.cls without even downloading it at all on the collaborative writing platform overleaf by starting your project from the quantumarticle template.

Dependencies

quantumarticle.cls should work with any reasonably recent LaTeX distribution. It further requires the following packages: xkeyval, etoolbox, geometry, xcolor, fancyhdr, tikz, hyperref, ltxgrid and ltxcmds (often distributed along with revtex, in texlive for example as part of texlive-publishers), as well as at least either lmodern or type1ec. We recommend to have natbib and at least one of bbm or dsfont installed. All of these should be included in the full install variant of your LaTeX distribution (for example texlive-full).

Compatibility

The quantumarticle class tries to be maximally compatible with existing document classes, such as, article, revtex, iopart, and elsarticle. It supports all standard options, like twocolumn, onecolumn, titlepage, as well as the standard syntax for defining the title page with the \author, \address, and \affiliation commands and the abstract environment.

Beta features

In addition, this document class come bundled with two new extras (currently in beta phase):

  1. The quantum-plots.ipynb Jupyter notebook and matplotlib style for effortlessly producing professional looking plots in python.

  2. The quantum-lyx-template.lyx LxY layout, which allow you to generate the LaTeX source of your quantumarticle manuscript with the LyX document processor.

Changelog

New in v5.0:

  • force users to specify a paper size to prevent unexpected behavior
  • option processing is now done exclusively by means of xkeyval
  • improved compatibility with frequently used LaTeX document classes
  • improved/added options for using this document class for manuscripts not intended for submission to Quantum
  • documents not intended for submission to Quantum can now be compiled with compilers different from PdfLaTeX (e.g. LuaLaTeX)
  • use https in links when possible
  • prevent usage of the \today macro in \date to avoid changing dates in documents when they are re-compiled on the arXiv
  • enforce that users put \pdfoutput=1 (as recommended by the arXiv) to prevent problems with multi-line hyper links
  • improved error messages
  • fixed a bug that lead to the title not being centered with the titlepage option
  • better layout of titles
  • fixed various bugs in option processing
  • the document class is now documented in quantumarticle.pdf
  • introduced the plotting notebook quantum-plots.ipynb as a beta feature
  • introduced the LyX template quantum-lyx-template.lyx as a beta feature

Contributors

Developed by: Christian Gogolin, Christopher Granade, Johannes J. Meyer, and Victor V. Albert

With contributions from: Shahnawaz Ahmed, Andrey Rakhubovsky, liantze, and Abhinav Deshpande

Contributing

In case you encounter problems using the article class please consider opening a bug report in our bug-tracker on GitHub. You can also contact us via email under latex@quantum-journal.org, but it may take significantly longer to get a response. In any case we need the full source of a document that produces the problem and the log file showing the error to help you.

Improvements submitted as pull requests against the develop branch are very much appreciated!

Copyright

Copyright 2017, 2018, 2019 Verein zur Förderung des Open Access Publizierens in den Quantenwissenschaften (http://quantum-journal.org/about/)

quantumarticle.cls is derived from article.cls available from https://www.ctan.org/pkg/article

It may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3c of this license or (at your option) any later version. The latest version of this license is in http://www.latex-project.org/lppl.txt and version 1.3c or later is part of all distributions of LaTeX version 2005/12/01 or later.

You can’t perform that action at this time.