How project-gemmi/gemmi works
Project type and purpose
• This is “gemmi”: an open‐source C++ library (C++14) for macromolecular crystallography and CIF/STAR file handling.
• It provides core functionality (read/write structures, symmetry, maps, reflections), plus:
• Command‐line tools (C++ executables under prog/)
• Python bindings (python/ + pyproject.toml)
• Fortran interface (fortran/)
• WebAssembly bindings (wasm/)
• Documentation (docs/)
• Use cases include library integration, interactive scripting, batch CLI processing and in‐browser demos.
File structure
• Top‐level directories:
• /gemmi & src/…: the core C++ library implementation
• prog/: CLI executables built on the library
• python/: Python extension modules (C++ glue + stubs)
• fortran/: Fortran wrappers, Makefile
• wasm/: Emscripten‐based WASM build, JS glue, TypeScript definitions
• docs/: Sphinx documentation source, code examples
• examples/: standalone demos in Python and C++
• tests/: unit and integration tests
• third_party/: bundled dependencies (PEGTL parser, zlib, doctest, etc.)
• tools/: helper scripts for release, CI, data generation
• Build and configuration: CMakeLists.txt at root; CI scripts in .github/workflows; pyproject.toml and setup.cfg for Python packaging; readthedocs.yaml for docs.
README for additional insights
• Confirms multi‐interface library: C++, Python, Fortran, WASM.
• Mentions online tools, documentation site, continuous integration, citation.
Diagramming recommendations
• Orange for CLI tools
• Yellow for Documentation system
• Gray for third‐party dependencies
• Purple for CI/CD & packaging pipeline
• From source directories into the build system
• From CI nodes to publish destinations (PyPI, ReadTheDocs)
Details without over‐splitting
• Major modules (include/, src/, prog/, python/, wasm/, fortran/, docs/, tests/, third_party/, tools/).
• Build pipeline: single CMake invocation producing library, executables, bindings, WASM.
• How tests and benchmarks consume the library.