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)
2017-03-22 13:56:57 +01:00
[](http://dx.doi.org/10.21105/joss.00204)
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
2018-08-17 09:28:12 +02:00
and figures.
2016-12-23 09:54:48 +01:00
**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.
2018-08-13 14:30:06 +02:00
* Capture Plots.jl figures *(or Gadfly and PyPlot on julia 0.6)* .
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
2018-08-13 14:30:06 +02:00
2017-03-30 17:25:41 +02:00
**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*
2017-03-14 17:08:15 +01:00
2017-03-06 16:43:12 +01:00
## Installation
You can install the latest release using Julia package manager:
```julia
2018-08-13 14:30:06 +02:00
using Pkg
2017-03-06 16:43:12 +01:00
Pkg.add("Weave")
```
2016-12-23 09:54:48 +01:00
## Usage
2018-08-13 14:30:06 +02:00
Run from julia using Plots.jl for plots:
2016-12-23 09:54:48 +01:00
```julia
2017-03-14 17:08:15 +01:00
#First add depencies for the example
2018-08-13 14:30:06 +02:00
using Pkg; Pkg.add.(["Plots", "DSP"])
2017-03-14 17:08:15 +01:00
#Use Weave
2016-12-23 09:54:48 +01:00
using Weave
2018-08-13 14:30:06 +02:00
weave(joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd"), out_path=:pwd)
2016-12-23 09:54:48 +01:00
```
2018-08-13 14:30:06 +02:00
If you have LaTeX installed you can also weave directly to pdf.
2016-12-23 09:54:48 +01:00
```julia
2018-08-13 14:30:06 +02:00
weave(joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd"),
out_path=:pwd, doctype="md2pdf")
2016-12-23 09:54:48 +01:00
```
## 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.
## 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.
