2016-12-23 09:54:48 +01:00
# Weave
[](https://travis-ci.org/mpastell/Weave.jl)
[](https://ci.appveyor.com/project/mpastell/weave-jl/branch/master)
[](https://coveralls.io/r/mpastell/Weave.jl?branch=master)
2017-03-14 17:08:15 +01:00
[](https://mpastell.github.io/Weave.jl/stable)
2016-12-23 09:54:48 +01:00
Weave is a scientific report generator/literate programming tool
for Julia. It resembles [Pweave ](http://mpastell.com/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**
2016-04-24 15:24:15 +02:00
* Noweb, markdown or script syntax for input documents.
2016-12-23 09:54:48 +01:00
* Execute code as terminal or "script" chunks.
2017-03-13 19:57:39 +01:00
* Capture Plots, Gadfly and PyPlot figures.
2016-04-24 15:24:15 +02:00
* Supports LaTex, Pandoc, Github markdown, MultiMarkdown, Asciidoc and reStructuredText output
2016-12-16 23:16:40 +01:00
* Publish markdown directly to html and pdf using Julia or Pandoc markdown.
2016-04-24 15:24:15 +02:00
* Simple caching of results
2016-12-12 13:05:26 +01:00
* Convert to and from IJulia notebooks
2016-04-24 15:24:15 +02:00
2017-03-14 17:08:15 +01:00
**Note about Julia 0.6**: Weave has been updated to support 0.6, but most of the depencies and plotting libraries have not. Plotting currently (14th March 2017) only works using PyPlot master.
2017-03-06 16:43:12 +01:00
## Installation
You can install the latest release using Julia package manager:
```julia
Pkg.add("Weave")
```
2016-12-23 09:54:48 +01:00
## Usage
Run from julia using Gadfly for plots:
```julia
2017-03-14 17:08:15 +01:00
#First add depencies for the example
Pkg.add.(["Cairo", "Fontconfig", "Gadfly"])
#Use Weave
2016-12-23 09:54:48 +01:00
using Weave
weave(Pkg.dir("Weave","examples","gadfly_sample.mdw"))
```
If you have Pandoc installed you can also weave directly to html and pdf.
```julia
weave(Pkg.dir("Weave","examples","gadfly_md_sample.jmd"), informat="markdown",
out_path = :pwd, doctype = "md2html")
```
## Documentation
Documenter.jl with MKDocs generated documentation:
[](https://mpastell.github.io/Weave.jl/stable)
[](https://mpastell.github.io/Weave.jl/latest)
## Editor support
I have made [language-weave ](https://atom.io/packages/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:
```clojure
(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.
