Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sisl/tufte_algorithms_book
A template for textbooks in the same style as Algorithms for Optimization
https://github.com/sisl/tufte_algorithms_book
Last synced: 3 months ago
JSON representation
A template for textbooks in the same style as Algorithms for Optimization
- Host: GitHub
- URL: https://github.com/sisl/tufte_algorithms_book
- Owner: sisl
- Created: 2019-06-21T02:04:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T19:16:54.000Z (7 months ago)
- Last Synced: 2024-08-01T16:43:48.614Z (6 months ago)
- Language: TeX
- Size: 276 KB
- Stars: 349
- Watchers: 24
- Forks: 68
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Support: support_code.jl
Awesome Lists containing this project
- my-awesome-github-stars - sisl/tufte_algorithms_book - A template for textbooks in the same style as Algorithms for Optimization (TeX)
README
# Tufte Algorithms Book Template
[](https://gitlab.com/johnnychen94/tufte_algorithms_book/commits/master)
This book template provides a starting point upon which authors may freely build to generate their own textbook entirely in LaTeX.
We used this setup for Algorithms for Optimization, and have continued to refine it for a new textbook on decision making under uncertainty.
The template allows for the direct compilation of a print-ready PDF, including support for figures, examples, and exercises.
We do all of our development in Ubuntu.
Install [Julia](https://julialang.org/downloads/).
Install LaTeX via texlive. We recommend [this repo](https://github.com/scottkosty/install-tl-ubuntu).
Clone the repository to a location of your choosing:
```
git clone https://github.com/sisl/tufte_algorithms_book.git
```
Initialize and update the submodules:
```
git submodule init
git submodule update
```
Compile the style:
```
cd style
sudo python setup.py install
cd ..
```
Compile the lexer:
```
cd lexer
sudo python setup.py install
cd ..
```
Install the required Julia packages (listed in the [Project.toml](https://github.com/sisl/tufte_algorithms_book/blob/master/Project.toml)). You can install them manually, or simply `instantiate` the project:
```julia
julia --project -e 'using Pkg; Pkg.instantiate()'
```
Install `pdf2svg`, which is used by PGFPlots (we assume Ubuntu - other operating systems may install pdf2svg differently):
```
sudo apt-get install pdf2svg
```
Install [pgfplots](https://ctan.org/pkg/pgfplots).
We require pythontex 0.18. You will probably have to update your version on texlive on miktex. Alternatively, you can download the latest version of pythontex from https://github.com/gpoore/pythontex.
(Note that on arch-based systems, one should use tllocalmgr instead.)
(If you see a pygments-related import error you might want to check out https://github.com/sisl/tufte_algorithms_book/issues/30 and try downgrading to Pygments 2.6.1)
## Test
Running `make test` pulls all the code and then runs all tests in `juliatest` blocks. See `runtests.jl` for details.
## Compilation
* `make compile` compiles the whole book
* `make compile CHAPTER='introduction chapter2\/introduction'` will comment out every `include` or `input` statement, except for `chapter/introduction` and `chapter/chapter2/introduction` where `chapter` can also be `appendix`. Requires `vim` to be installed.
* `make clean` removes all generated files except `book.pdf`
If you host your project under Gitlab, `.gitlab-ci.yml` is a CI/CD template to start with.