Weave.jl
Weave.jl: Scientific Reports Using Julia - Published in JOSS (2017)
Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
6 of 50 committers (12.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.6%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Scientific reports/literate programming for Julia
Basic Info
- Host: GitHub
- Owner: JunoLab
- License: mit
- Language: Julia
- Default Branch: master
- Homepage: http://weavejl.mpastell.com
- Size: 10.3 MB
Statistics
- Stars: 846
- Watchers: 15
- Forks: 95
- Open Issues: 153
- Releases: 40
Topics
Metadata Files
README.md
Weave
Weave is a scientific report generator/literate programming tool for the Julia programming language. It resembles Pweave, knitr, R Markdown, and Sweave.
You can write your documentation and code in input document using Markdown, Noweb or ordinal Julia script syntax,
and then use weave function to execute code and generate an output document while capturing results and figures.
Current features
- Publish markdown directly to HTML and PDF using Julia or Pandoc
- Execute code as in terminal or in a unit of code chunk
- Capture Plots.jl or Gadfly.jl figures
- Supports various input format: Markdown, Noweb, Jupyter Notebook, and ordinal Julia script
- Conversions between those input formats
- Supports various output document formats: HTML, PDF, GitHub markdown, Jupyter Notebook, MultiMarkdown, Asciidoc and reStructuredText
- Simple caching of results
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
```julia using Weave
add depencies for the example
using Pkg; Pkg.add(["Plots", "DSP"])
filename = normpath(Weave.EXAMPLEFOLDER, "FIRdesign.jmd") weave(filename, out_path = :pwd) ```
If you have LaTeX installed you can also weave directly to pdf.
julia
filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd")
weave(filename, out_path = :pwd, doctype = "md2pdf")
NOTE: Weave.EXAMPLE_FOLDER just points to examples directory.
Documentation
Documenter.jl with MKDocs generated documentation:
Editor support
Install language-weave to add Weave support to Juno. It allows running code from Weave documents with usual keybindings and allows preview of html and pdf output.
The Julia extension for Visual Studio Code adds Weave support to Visual Studio Code.
Contributing
You can contribute to this package by opening issues on GitHub or implementing things yourself and making a pull request. We'd also appreciate more example documents written using Weave.
Contributors
You can see the list of contributors on GitHub: https://github.com/JunoLab/Weave.jl/graphs/contributors . Thanks for the important additions, fixes and comments.
Example projects using Weave
- DiffEqTutorials.jl uses Weave to output tutorials (
.jmddocuments) to html, pdf and Jupyter notebooks. - TuringTutorials uses Weave to convert notebooks to html.
Related packages
- Literate.jl can be used to generate Markdown and Jupyter notebooks directly from Julia source files with markdown in comments.
- Quarto can generate Jupyter notebooks, HTML, or PDF directly from a Markdown format containing Julia code blocks, and also works with R and Python.
Owner
- Name: Juno
- Login: JunoLab
- Kind: organization
- Website: https://junolab.org
- Repositories: 24
- Profile: https://github.com/JunoLab
Interesting Development Environment
GitHub Events
Total
- Issues event: 1
- Watch event: 21
- Issue comment event: 1
- Fork event: 1
Last Year
- Issues event: 1
- Watch event: 21
- Issue comment event: 1
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Matti Pastell | m****l@h****i | 459 |
| Shuhei Kadowaki | a****k@g****m | 203 |
| Jonas Isensee | j****e@w****e | 20 |
| Giuseppe Ragusa | g****a@g****m | 12 |
| Sebastian Pech | s****h@m****m | 10 |
| Sebastian Pfitzner | p****b@g****m | 7 |
| Art Wild | w****t@g****m | 6 |
| Dave Kleinschmidt | d****t@g****m | 6 |
| Douglas Bates | d****s@g****m | 6 |
| Fredrik Bagge Carlson | b****n@g****m | 5 |
| Mike | m****y@g****m | 4 |
| David Anthoff | a****f@b****u | 4 |
| Matti Pastell | m****l@s****b | 4 |
| Tamas K. Papp | t****p@g****m | 3 |
| Tamas Nagy | t****s@t****m | 3 |
| Tony Kelman | t****y@k****t | 3 |
| github-actions[bot] | 4****] | 3 |
| Gerhard Aigner | a****r@t****e | 2 |
| Tom Short | t****s@g****m | 2 |
| Nicholas W. M. Ritchie | n****e@n****v | 2 |
| Sheehan Olver | s****r@m****m | 2 |
| femtocleaner[bot] | f****] | 2 |
| schrimpf | s****f@m****a | 2 |
| KristofferC | k****n@j****m | 1 |
| Amin Yahyaabadi | a****4@g****m | 1 |
| ilia-kats | i****s@g****t | 1 |
| evalparse | z****i@g****m | 1 |
| bramtayl | b****1@g****m | 1 |
| Xing Shi Cai | n****i@g****m | 1 |
| Viral B. Shah | v****l@m****g | 1 |
| and 20 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 75
- Total pull requests: 38
- Average time to close issues: 6 months
- Average time to close pull requests: 2 months
- Total issue authors: 64
- Total pull request authors: 27
- Average comments per issue: 2.19
- Average comments per pull request: 1.74
- Merged pull requests: 19
- Bot issues: 0
- Bot pull requests: 5
Past Year
- Issues: 2
- Pull requests: 0
- Average time to close issues: 2 minutes
- Average time to close pull requests: N/A
- Issue authors: 2
- Pull request authors: 0
- Average comments per issue: 0.5
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- ChrisRackauckas (4)
- newptcai (3)
- aviatesk (2)
- dlfivefifty (2)
- vjd (2)
- bencottier (2)
- likanzhan (2)
- 00krishna (2)
- clintonTE (1)
- mtfishman (1)
- backwardscoder (1)
- AsimHDar (1)
- BeastyBlacksmith (1)
- nmheim (1)
- einzigsue (1)
Pull Request Authors
- github-actions[bot] (5)
- dlfivefifty (3)
- aviatesk (3)
- MichaelHatherly (2)
- newptcai (2)
- william-shere (2)
- tlnagy (2)
- NicholasWMRitchie (2)
- torfjelde (1)
- pfitzseb (1)
- mpastell (1)
- ErickChacon (1)
- xgdgsc (1)
- sebastianpech (1)
- likanzhan (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 199 total
- Total dependent packages: 8
- Total dependent repositories: 4
- Total versions: 26
juliahub.com: Weave
Scientific reports/literate programming for Julia
- Homepage: http://weavejl.mpastell.com
- Documentation: https://docs.juliahub.com/General/Weave/stable/
- License: MIT
-
Latest release: 0.10.12
published about 3 years ago
Rankings
Dependencies
- julia-actions/setup-julia latest composite
- JuliaRegistries/TagBot v1 composite
- actions/checkout v2 composite
- codecov/codecov-action v1 composite
- julia-actions/julia-buildpkg latest composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest latest composite
- julia-actions/setup-julia v1 composite