An open source scientific article created using the showyourwork workflow.
The only requirement is the Python package showyourwork and git.
Important
The package is stable but still under development.
Depending when your cloned this repository, if you encounter some issue
try to install it from the latest commit on the stable branch with,
pip install git+https://github.com/showyourwork/showyourwork.git
How and where to install it will depend on your preferences, e.g.:
- use only your Python3 installation and the
venv
Standard Library module - use conda
Please, check showyourwork docs and its repository for documentation and help on any issue with it.
showyourwork uses snakemake v7.15.2 for defining a workflow.
You can start a new project by using this repository as a template.
Using the web page, click on the green button "Use this template" and then "Create a new repository".
See GitHub Docs for more details.
After installing showyourwork, clone this repository with git,
git clone https://github.com/YourUser/YourProjectName
Enter in the new directory and run showyourwork build
.
showyourwork uses tectonic as its typesetting system.
Currently tectonic uses a relatively old version of biblatex. If you need biber to manage your bibliography, for the moment you have to use biber v2.17.
On macos you can install it with Homebrew
brew install dgfl-gh/taps/[email protected]