Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.12 KB

README.rst

File metadata and controls

45 lines (30 loc) · 1.12 KB

Tikzify

A set of utilities for programmatically generating TikZ code.

Contribution guidelines

  • Conventions
    • Naming conventions are according to PEP8.
  • How to clean the source:
    • ruff .
    • pyright
    • mypy
    • isort .
    • pylint tikzify

Running

  • This macro is helpful for running examples:
function dm {
    python "$1.py" $2 && pdflatex -shell-escape $1 && open $1.pdf
}
  • The basal ganglia example can be run by doing dm basal_ganglia from the examples folder. It should produce examples/basal_ganglia.pdf, which shows all of the output, as well as examples/figures/basal_ganglia-*.pdf, which are the individual diagrams to be included.
  • A copy of the pdf <examples/basal_ganglia.pdf> is provided. It shows three programmatically-generated diagrams, with various sections highlighted.

Whom do I talk to?

  • Neil Girdhar