mirror of https://github.com/mpastell/Weave.jl
79 lines
3.1 KiB
Markdown
79 lines
3.1 KiB
Markdown
# 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)
|
|
[](https://mpastell.github.io/Weave.jl/stable)
|
|
[](http://dx.doi.org/10.21105/joss.00204)
|
|
|
|
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**
|
|
|
|
* Noweb, markdown or script syntax for input documents.
|
|
* Execute code as terminal or "script" chunks.
|
|
* Capture Plots.jl figures *(or Gadfly and PyPlot on julia 0.6)*.
|
|
* 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*
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
You can install the latest release using Julia package manager:
|
|
|
|
```julia
|
|
using Pkg
|
|
Pkg.add("Weave")
|
|
```
|
|
|
|
## Usage
|
|
|
|
Run from julia using Plots.jl for plots:
|
|
|
|
```julia
|
|
#First add depencies for the example
|
|
using Pkg; Pkg.add.(["Plots", "DSP"])
|
|
#Use Weave
|
|
using Weave
|
|
weave(joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd"), out_path=:pwd)
|
|
```
|
|
|
|
If you have LaTeX installed you can also weave directly to pdf.
|
|
|
|
```julia
|
|
weave(joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd"),
|
|
out_path=:pwd, doctype="md2pdf")
|
|
```
|
|
|
|
## 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.
|