Code Monkey home page Code Monkey logo

juliaconsubmission.jl's Introduction

JuliaConSubmission

This repository is an example for a proceeding submission at JuliaCon. Feel free to use the template in /paper to prepare yours. For more information, check out the author's guide and proceedings.juliacon.org.

Importing into your project

Important do no fork this repo to create a JuliaCon submission. The JuliaCon paper should live in the repository of the software you are presenting in a /paper folder at the top-level. If you do not want to introduce a /paper folder in your software, you can do so in an arbitrary branch.

Paper dependencies

The document can be built locally, the following dependencies need to be installed:

  • Ruby
  • latexmk

Build process

Build the paper using:

$ latexmk -bibtex -pdf paper.tex

Clean up temporary files using:

$ latexmk -c

Paper metadata

IMPORTANT Some information for building the document (such as the title and keywords) is provided through the paper.yml file and not through the usual \title command. Respecting the process is important to avoid build errors when submitting your work.

Get from OverLeaf

The paper folder can be downloaded from OverLeaf.

juliaconsubmission.jl's People

Contributors

blegat avatar carstenbauer avatar jeffreysarnoff avatar jorgepz avatar matbesancon avatar pat-alt avatar ranocha avatar schillic avatar simonbyrne avatar vchuravy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

juliaconsubmission.jl's Issues

Possible improvements of the JuliaCon LateX class

This issue follows some remarks left on the juliacon channel on Slack

  1. The code environment does not wrap code to a new line at the value corresponding to the width of the environment, so we do have to tweak things manually (which is not horrible). Maybe we could solve things by adding a submission style in JuliaFormatter.jl that include the exact width (seems to be 63 characters)
  2. I, personally, find the itemized bullet style terrible as there is no space at all between the hyphen and the first character following it. I would not complain if we have something different (a simple bullet would do …) from next JuliaCon.

Note that these are very small and not important complaints. I do love the juliacon logo on top

Linebreak in title and authors

Is it possible to add a linebreak in the title or authors? My title currently looks like this:

image

So the first line is very long and the second very short, not to mention the start of the title is slightly overlapping with the JuliaCon logo. If it was pure .tex, I could just add \\ after "for" to get the following:

image

Which looks much better. I tried to do this in the .yml and it just doesn't work. One of my colleagues is also having a related issue where the name of one of the authors is split between two lines.

So, is there any way to add a linebreak in the .yml?

Captions in `lstlisting` have narrow horizontal width

Hey,
changing the lstlisting example slightly to

\begin{lstlisting}[language = Julia, caption={Hello Julia}]
using Plots

x = -3.0:0.01:3.0
y = rand(length(x))
plot(x, y)
\end{lstlisting}

results in this.

What would we need to change?

Thanks,
Felix

Printing URLs in References

The bib entry

@misc{juliacontemplate,
	title = {JuliaConSubmission.jl : An example package for submissions to JuliaCon},
	url = {https://github.com/JuliaCon/JuliaConSubmission.jl},
	urldate = {2020-08-31},
	year = {2020},
}

is printed as

[1]  Juliaconsubmission.jl : An example package for submissions to juliacon, 2020.

in the references section. I think the URL of the bib item should also be printed in the references. Any idea how to do it?

PDF Metadata

I played around with the template locally and noticed that the PDF metadata wasn't embedded in the code. I ended up using something à la

\hypersetup{
pdftitle = {Econometrics.jl},
pdfsubject = {JuliaCon 2019 Proceedings},
pdfauthor = {José Bayoán Santiago Calderón},
pdfkeywords = {Julia, Econometrics, Statistical Software, Software Validation}
}

I don't know if someone wants to make a PR to pre-fill those values from the YAML file.

Odd line wrapping behaviour for `lstlisting` captions

Hi,

Firstly many thanks for this template!

I'd like to cross-reference my code listings and have noted some odd behaviour for the captions. Here's my listing:

\begin{lstlisting}[language=Julia, escapechar=@, numbers=left, label={lst:binary-advanced}, caption={An advanced usage example involving the DiCE Generator.}]
# Counterfactual search:
opt = Flux.Optimise.Descent(1.0) @\label{line:binary-advanced-opt}@
generator = DiCEGenerator(;opt = opt) @\label{line:binary-advanced-dice}@
counterfactuals = generate_counterfactual(
    x, target, counterfactual_data, M, generator;
    num_counterfactuals=5 @\label{line:binary-advanced-num}@
)
# Plotting
plt = plot(counterfactuals)
\end{lstlisting}

This is what it generates:

Screenshot 2022-10-07 at 17 21 52

I haven't seen captions for listings in any of the previous proceedings, so perhaps this is intentional? For now I'll submit with empty captions, but would be great to find a solution. Any advice would be much appreciated.

Have a good weekend 👋🏽

Paper specifications? (a4/letter, page limit)

I'm trying to find the specifications of page limit and paper size for the proceedings.
One author asked if it was ok to use single column, and another has formatted for A4 paper...
Thanks

last line of Abstract looks out of place

Abstract

This paper offers a new perspective on the antics of that quick brown fox,
that they serve to mitigate canine lassitude and encourage cow jumping.
    Proceedings of JuliaCon

Using biblatex instead of bibtex

Proposal:

biblatex is the preferred bibliography management in LaTeX and uses biber over bibtex as the backend. In terms of actual output changes, it would be nice to include the DOI which I think it is an improvement over the current output.

  • Add to cls,
\usepackage[maxbibnames=99,
            ]{biblatex}
\addbibresource{ref.bib}
  • Delete juliacon.bst, bib.tex, and \input{bib.tex} in paper.tex

[Proposal] Quarto extension for JuliaCon Proceedings

Hi there,

I've been working on a Quarto extension for JuliaCon Proceedings: https://github.com/pat-alt/quarto-juliacon-proceedings. It is built on top of the LaTeX class contained in this repo (though with minor edits to the cls file, tracked here). It needs some more work but could eventually enable authors to write the proceedings articles in Quarto with ease. The repo contains more information including links to examples that can be used to spot any remaining discrepancies.

What is Quarto?

Quarto makes it easy to write reproducible documents that can be rendered to PDF, HTML, Word and more. It is based on Markdown, which is easy to learn and write. It also supports LaTeX, which is useful for more advanced formatting. As this extension demonstrates, Quarto is also very flexible and can be extended with custom templates and styles.

Why Quarto?

By embracing Quarto, JuliaCon Proceedings can set an example for how to write reproducible documents. We would not only make it easier for authors to write their submissions but also open the door for more advanced features such as interactive figures and executable code blocks in HTML documents.

Note

Some of the examples contained in the repo also include HTML versions. Those are still in default format but should provide a good idea of what is possible.

The template discusses some further advantages: pdf, html.

Remaining Discrepancies

There are some remaining discrepancies. I've opened issues for all of the discrepancies that I have discovered so far. The rendered PDF of my recent JuliaCon publication serves as a comparison to the published version. If you spot any differences not currently listed in issues, please open a new issue.

BTW, this is what a corresponding HTML version of a JuliaCon Proceedings paper could look like.

Help appreciated

I not very good with LaTex, so if this proposal is of interest, I'd much appreciate your support with this 😅

Any thoughts/questions welcome!

Julia style with unicode characters

Hi,

First off, thanks for your work on this great submission template.

I have found that the listings package doesn't like some unicode characters that we use in our Julia library, eg.

\begin{lstlisting}[label=composition, numbers=left, mathescape]
Ω₀ = CH(X₀, Φ*X₀ ⊕ E₊(X₀))
\end{lstlisting}

gives an error.

A workaround is to escape the math commands like this:

\begin{lstlisting}[label=composition, numbers=left, mathescape]
$\Omega_0$ = CH($X_0, \Phi*X_0 \oplus E_+$)
\end{lstlisting}

While this shows the code, I find this is not great because the colors are wrong (all math characters in dollar signs are shown in red).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.