mirrors
/
Weave.jl
mirror of https://github.com/mpastell/Weave.jl
1
0
Fork 0
Code Issues Releases Wiki Activity
550 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 a9120129ab Clean temp directories 2019-03-03 14:13:08 +02:00
bin Remove plot library hack and use Requires instead 2018-07-26 20:32:10 +03:00
doc Update docs 2018-08-13 14:51:08 +02:00
examples Update README and example 2018-08-13 14:30:06 +02:00
paper Updated citation #85 2017-03-15 17:07:25 +02:00
src Clean temp directories 2019-03-03 14:13:08 +02:00
templates Add bibtex support to md2pdf 2019-03-03 10:44:16 +02:00
test Add simple list of references 2019-03-01 16:59:49 +02: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 Remove 0.7 from tests 2019-01-03 15:46:12 +02:00
LICENSE.md Update LICENSE.md 2017-03-13 18:38:06 +02:00
Manifest.toml Add BibTex to Project.toml 2019-02-28 23:39:49 +02:00
NEWS.md Fix mimetype order for md2html 2017-03-14 18:54:03 +02:00
Project.toml Add BibTex to Project.toml 2019-02-28 23:39:49 +02:00
README.md Cleaning for Julia 1.0 (#141) 2018-08-17 10:28:12 +03:00
REQUIRE Start working on ctation rendering 2019-03-01 10:47:29 +02:00
appveyor.yml Remove 0.7 from tests 2019-01-03 15:46:12 +02: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.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

Weave code and output

Installation

You can install the latest release using Julia package manager:

using Pkg
Pkg.add("Weave")

Usage

Run from julia using Plots.jl for plots:

#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.

weave(joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd"),
    out_path=:pwd, doctype="md2pdf")

Documentation

Documenter.jl with MKDocs generated documentation:

Editor support

I have made 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.