{"id":13596122,"url":"https://github.com/sisl/tufte_algorithms_book","last_synced_at":"2025-09-13T11:21:22.024Z","repository":{"id":48710960,"uuid":"193013599","full_name":"sisl/tufte_algorithms_book","owner":"sisl","description":"A template for textbooks in the same style as Algorithms for Optimization","archived":false,"fork":false,"pushed_at":"2024-06-20T19:16:54.000Z","size":283,"stargazers_count":352,"open_issues_count":9,"forks_count":66,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-11-06T19:41:06.031Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sisl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support_code.jl","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-21T02:04:53.000Z","updated_at":"2024-10-23T17:22:42.000Z","dependencies_parsed_at":"2024-08-01T16:40:50.118Z","dependency_job_id":"59a6205e-341d-40b5-a2f4-7c0518ea1511","html_url":"https://github.com/sisl/tufte_algorithms_book","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisl%2Ftufte_algorithms_book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisl%2Ftufte_algorithms_book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisl%2Ftufte_algorithms_book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisl%2Ftufte_algorithms_book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sisl","download_url":"https://codeload.github.com/sisl/tufte_algorithms_book/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248067771,"owners_count":21042352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T16:02:08.902Z","updated_at":"2025-04-09T16:31:33.846Z","avatar_url":"https://github.com/sisl.png","language":"TeX","funding_links":[],"categories":["TeX"],"sub_categories":[],"readme":"# Tufte Algorithms Book Template\n\n[![pipeline status](https://gitlab.com/johnnychen94/tufte_algorithms_book/badges/master/pipeline.svg)](https://gitlab.com/johnnychen94/tufte_algorithms_book/commits/master)\n\nThis book template provides a starting point upon which authors may freely build to generate their own textbook entirely in LaTeX.\nWe used this setup for Algorithms for Optimization, and have continued to refine it for a new textbook on decision making under uncertainty.\nThe template allows for the direct compilation of a print-ready PDF, including support for figures, examples, and exercises.\n\nWe do all of our development in Ubuntu.\n\n\nInstall [Julia](https://julialang.org/downloads/).\n\nInstall LaTeX via texlive. We recommend [this repo](https://github.com/scottkosty/install-tl-ubuntu).\n\nClone the repository to a location of your choosing:\n```\ngit clone https://github.com/sisl/tufte_algorithms_book.git\n```\n\nInitialize and update the submodules:\n```\ngit submodule init\ngit submodule update\n```\n\nCompile the style:\n```\ncd style\nsudo python setup.py install\ncd ..\n```\n\nCompile the lexer:\n```\ncd lexer\nsudo python setup.py install\ncd ..\n```\n\nInstall 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:\n```julia\njulia --project -e 'using Pkg; Pkg.instantiate()'\n```\n\nInstall `pdf2svg`, which is used by PGFPlots (we assume Ubuntu - other operating systems may install pdf2svg differently):\n```\nsudo apt-get install pdf2svg\n```\n\nInstall [pgfplots](https://ctan.org/pkg/pgfplots).\n\nWe 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.\n\n(Note that on arch-based systems, one should use tllocalmgr instead.)\n\n(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)\n\n## Test\n\nRunning `make test` pulls all the code and then runs all tests in `juliatest` blocks. See `runtests.jl` for details.\n\n## Compilation\n\n* `make compile` compiles the whole book\n* `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.\n* `make clean` removes all generated files except `book.pdf`\n\nIf you host your project under Gitlab, `.gitlab-ci.yml` is a CI/CD template to start with.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsisl%2Ftufte_algorithms_book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsisl%2Ftufte_algorithms_book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsisl%2Ftufte_algorithms_book/lists"}