Quickstart

Installation

Pour installer phystool dans un environnement virtuel, il suffit de passer par pip:

pip install phystool

Important

Afin de permettre à phystool de parser correctement les logs \(\LaTeX\), il faut légèrement modifier la configuration du compilateur afin que les logs affichent des lignes plus longues. Pour cela, il suffit de modifier/rajouter la ligne suivante au fichier texmf.cnf:

max_print_line=1000

Dépendances

Python 3.12
git
ripgrep: Utilisé pour chercher des chaines de caractères dans les fichiers .tex.
bat: Utilisé pour afficher le contenu des fichier .tex dans le terminal et pour afficher les modifications suivies par git.
delta: Utilisé pour afficher les modifications suivies par git.

Premier démarrage

Lors de la première utilisation, il est conseillé d’exécuter physnoob car l’interface graphique donne directement accès aux .pdf. Au démarrage, le fichier de configuration ~/.phystool/phystool.conf est chargé. Si celui-ci n’existe pas, il est automatiquement crée et son contenu est par défaut:

[phystool]
db = ~/physdb

[physnoob]
editor = kile

[latex]
auto = physauto_dev
tikz = phystikz_dev

[git]
theme = --commit-decoration-style '130 box' --dark --file-decoration-style '"#606018" overline' --file-added-label '[●]' --file-copied-label '[C]' --file-modified-label '[+]' --file-removed-label '[⛌]' --file-renamed-label '[→]' --file-style '232 bold 184' --hunk-header-style 'syntax bold italic 237' --line-numbers --line-numbers-left-format '"{nm:>1}┊"' --line-numbers-left-style 'red' --line-numbers-minus-style 'red bold' --line-numbers-plus-style 'green bold' --line-numbers-right-format '" {np:>1}┊"' --line-numbers-right-style 'green' --line-numbers-zero-style '"#545474" italic' --minus-emph-style 'normal "#80002a"' --minus-style 'normal "#5e0000"' --plus-emph-style 'syntax bold "#007e5e"' --plus-style 'syntax "#003500"' --syntax-theme 'OneHalfDark' --whitespace-error-style '"#80002a" reverse' --zero-style 'syntax' --blame-format '"{author:<18} ({commit:>7}) ┊{timestamp:^16}┊ "' --no-gitconfig --side-by-side --width 200 --tabs 4

Une explication détaillée de ce fichier de configuration sera abordée plus loin mais il est pour l’instant suffisant de comprendre que durant ce premier démarrage, le répertoire ~/physdb a été crée et qu’il contient quelques PDBfile qui féliciteront la prise en main de phystool.