How badw/puppy works
Project type and purpose
• From the README (“puppy – Phonon Unfolding and Projections”) and the src/puppy modules, this is a Python scientific library/tool for unfolding phonon bands around crystal defects and projecting eigendisplacements onto dispersion curves.
• It is not a web or full-stack application but a domain-specific computational library with example notebooks.
File structure
• Top level:
• src/puppy/ – core Python package
• examples/ – Jupyter notebooks and example data sets (host, solid_solution, experimental)
• static/ – logo and generated images
• pyproject.toml – packaging/config
• Inside src/puppy/:
• analysis.py – routines to read phonon data and compute unfolding/projections
• unfolder.py – algorithms to perform the actual band-unfolding
• plotting.py – visualization functions for results
• _deprecated.py – legacy code
README for additional insights
• Installation via pip install .
• Example notebooks drive the library, loading FORCE_CONSTANTS from example subfolders
• Outputs are figures (e.g., static/unfolded.png)
Be detailed and capture essential elements
• Break the core library into its 3 subcomponents.
• How examples supply data and consume the library’s API.
• Packaging boundary (pip installation) if relevant for deployments.
• Keep the layout horizontal: Examples on the left, core library in the middle, Data Assets below, static output on the right.