How rougier/scientific-visualization-book works
And group the major components
• Book Content & Chapters:
• The “rst” directory contains all chapters and supplemental text (e.g., 00-preface.rst, 00-introduction.rst, etc.). These represent the authored narrative of the book.
• The “tex” directory holds the LaTeX sources and related build files (book.tex, cover files, bibliography, etc.), which are used to compile the final PDF.
• Code Examples & Illustrations:
• The “figures” directory holds the generated PDFs, images, and even video outputs (like MP4) corresponding to those code examples.
• Design Assets:
• “cover” holds assets for cover design.
• “images” and “fonts” provide additional visual resources for both online and printed versions.
• Build Infrastructure & Automation:
• Files like “Makefile”, “scripts/build_book”, and “rst2latex.py” serve as the glue that orchestrates building the book. They tie together the chapter sources, code examples, and LaTeX compilation.
• The presence of configuration and deployment files (e.g., GitHub funding, .gitignore, and repository-level configuration) supports project management and collaboration.
• Supplementary Materials:
• “pdf” contains the compiled book outputs.
• “tex” is used by the build system to compile LaTeX, while “rst” provides the raw content for conversion.
Relationships and data flow
• How the “rst” content flows into the build system (via rst2latex.py, Makefile, and scripts) to generate LaTeX files in “tex” and then compile into the final PDF in “pdf”.
• That the build scripts and Makefile are central orchestration components that tie together content, code-generated artifacts, and resources.
Architectural patterns and design principles
• Modularity/Separation of Concerns: The clear separation into directories (content, code examples, assets, and build tools) shows a modular design where each component has a well-defined responsibility.
• Data Flow versus Control Flow: Emphasize the data flow from authored source (rst files) and dynamically generated figures (code → figures) into the final output (LaTeX → PDF).
• Reusability & Extensibility: Code examples are organized by topics showing that new materials or modules can easily be added; similarly, assets like fonts and images are maintained separately for reuse.