mirrors
/
Weave.jl
mirror of https://github.com/mpastell/Weave.jl
1
0
Fork 0
Code Issues Releases Wiki Activity
504 Commits
14 Branches
45 Tags
11 MiB
Julia 85.1%
CSS 7.9%
Jupyter Notebook 2.2%
TeX 1.9%
Smarty 1.5%
Other 1.4%
 
 
 
 
 
 
Go to file
Matti Pastell 9aa01e4b89
Get CI running on 0.7 (#137) 		2018-08-13 15:06:07 +03:00
bin Remove plot library hack and use Requires instead 2018-07-26 20:32:10 +03:00
doc Update figure options in docs 2018-07-27 01:30:21 +03:00
examples Fix header parsing, update example 2018-07-26 00:26:38 +03:00
paper Updated citation #85 2017-03-15 17:07:25 +02:00
src Allow custom fields in templates, closes #100 2018-07-27 14:39:53 +03:00
templates Use Highlights.jl for md2tex output 2018-07-24 23:40:47 +02:00
test Update tests rc2 2018-08-07 12:54:51 +03:00
.gitattributes Fix handling of \r #72 2016-12-22 21:40:07 +02:00
.gitignore Fix CRLF in rest of the files 2016-12-23 10:54:48 +02:00
.travis.yml Get CI running on 0.7 (#137) 2018-08-13 15:06:07 +03:00
LICENSE.md Update LICENSE.md 2017-03-13 18:38:06 +02:00
NEWS.md Fix mimetype order for md2html 2017-03-14 18:54:03 +02:00
Project.toml Get CI running on 0.7 (#137) 2018-08-13 15:06:07 +03:00
README.md Update tests 2018-01-02 15:54:55 +02:00
REQUIRE Bump highlights in deps 2018-08-06 11:04:11 +03:00
appveyor.yml Get CI running on 0.7 (#137) 2018-08-13 15:06:07 +03:00

README.md

Weave

Build Status Build status Coverage Status

Weave is a scientific report generator/literate programming tool for Julia. It resembles Pweave, Knitr, rmarkdown and Sweave.

You can write your documentation and code in input document using Noweb, Markdown, Script syntax and use weave function to execute to document to capture results and figures.

Current features

  • Noweb, markdown or script syntax for input documents.
  • Execute code as terminal or "script" chunks.
  • Capture Plots, Gadfly and PyPlot figures.
  • Supports LaTex, Pandoc, Github markdown, MultiMarkdown, Asciidoc and reStructuredText output
  • Publish markdown directly to html and pdf using Julia or Pandoc markdown.
  • Simple caching of results
  • Convert to and from IJulia notebooks

Citing Weave: Pastell, Matti. 2017. Weave.jl: Scientific Reports Using Julia. The Journal of Open Source Software. http://dx.doi.org/10.21105/joss.00204

Weave code and output

Installation

You can install the latest release using Julia package manager:

Pkg.add("Weave")

Usage

Run from julia using Gadfly for plots:

#First add depencies for the example
Pkg.add.(["Cairo", "Fontconfig", "Gadfly"])
#Use Weave
using Weave
weave(Pkg.dir("Weave","examples","gadfly_sample.mdw"))

If you have Pandoc installed you can also weave directly to html and pdf.

weave(Pkg.dir("Weave","examples","gadfly_md_sample.jmd"), informat="markdown",
  out_path = :pwd, doctype = "md2html")

Documentation

Documenter.jl with MKDocs generated documentation:

Editor support

I have made language-weave package for Atom to do the syntax highlighting correctly.

Noweb documents work well with ESS as well, to set doc-mode for .mdw files to markdown and code to Julia you can do:

(defun mdw-mode ()
       (ess-noweb-mode)
       (setq ess-noweb-default-code-mode 'ess-julia-mode)
       (setq ess-noweb-doc-mode 'markdown-mode))

(setq auto-mode-alist (append (list (cons "\\.mdw$" 'mdw-mode))
                   auto-mode-alist))

Contributing

I will probably add new features to Weave when I need them myself or if they are requested and not too difficult to implement. You can contribute by opening issues on Github or implementing things yourself and making a pull request. I'd also appreciate example documents written using Weave to add to examples.

Contributors

You can see the list of contributors on Github: https://github.com/mpastell/Weave.jl/graphs/contributors. Thanks for the important additions, fixes and comments.