{"id":13995698,"url":"https://github.com/phys-sim-book/mdbook-src","last_synced_at":"2025-07-22T22:32:16.435Z","repository":{"id":241964334,"uuid":"770011475","full_name":"phys-sim-book/mdbook-src","owner":"phys-sim-book","description":"The mdbook source of a free online book on the theory and algorithms of physics-based simulations. You are welcome to make contributions by submitting pull requests or directly contacting the authors.","archived":false,"fork":false,"pushed_at":"2024-08-12T01:50:10.000Z","size":15300,"stargazers_count":86,"open_issues_count":1,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-08-12T02:53:46.592Z","etag":null,"topics":["collision-handling","computer-graphics","elastodynamics","finite-element-methods","incremental-potential-contact","physics-based-simulation"],"latest_commit_sha":null,"homepage":"https://phys-sim-book.github.io/","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phys-sim-book.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-10T17:18:00.000Z","updated_at":"2024-08-12T01:50:14.000Z","dependencies_parsed_at":"2024-06-07T22:50:28.560Z","dependency_job_id":"68d2d6e8-3ee8-4b15-89c5-f499974b295d","html_url":"https://github.com/phys-sim-book/mdbook-src","commit_stats":null,"previous_names":["phys-sim-book/mdbook-src"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phys-sim-book%2Fmdbook-src","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phys-sim-book%2Fmdbook-src/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phys-sim-book%2Fmdbook-src/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phys-sim-book%2Fmdbook-src/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phys-sim-book","download_url":"https://codeload.github.com/phys-sim-book/mdbook-src/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227190302,"owners_count":17745243,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collision-handling","computer-graphics","elastodynamics","finite-element-methods","incremental-potential-contact","physics-based-simulation"],"created_at":"2024-08-09T14:03:33.418Z","updated_at":"2024-11-29T18:30:51.317Z","avatar_url":"https://github.com/phys-sim-book.png","language":"TeX","readme":"# mdBook Source of Physics-Based Simulation\n\nThis online book is developed based on [mdBook](https://github.com/rust-lang/mdBook). The book is fully open-sourced, and we welcome your contributions!\n\nmd files of each chapter of the book is in `src/`.\n\n[Python](https://github.com/phys-sim-book/solid-sim-tutorial) and [CUDA](https://github.com/phys-sim-book/solid-sim-tutorial-gpu) implementations of certain topics are included as submodules and discussed in the book. Thus, to clone the source with submodules:\n```\ngit clone --recurse-submodules https://github.com/phys-sim-book/mdbook-src.git\n```\nTo update submodules:\n```\ngit submodule update --init --recursive\n```\n\nTo generate the online book from the md files:\n\n**MacOS**\n\n1. Download mdBook binary from https://github.com/rust-lang/mdBook/releases and put it into the root directory of this repository\n2. Install rust, which may take a while. On Mac: `brew install rust`\n3. Install [mdbook-katex](https://github.com/lzanini/mdbook-katex) plugin via `cargo install mdbook-katex`\n4. Install [mdbook-numeq](https://github.com/yannickseurin/mdbook-numeq) plugin via `cargo install mdbook-numeq`\n5. Install [mdbook-numthm](https://github.com/yannickseurin/mdbook-numthm) plugin via `cargo install mdbook-numthm`\n6. Install [mdbook-bib](https://github.com/francisco-perez-sorrosal/mdbook-bib) plugin via `cargo install mdbook-bib`\n7. Add cargo path to PATH via `export PATH=\"/Users/your-user-name/.cargo/bin:$PATH\"`\n8. Init, build, and view the online book following https://rust-lang.github.io/mdBook/cli/index.html\n\n**Windows**\n\n1. Download mdBook binary from https://github.com/rust-lang/mdBook/releases and put `mdbook.exe` into the root directory of this repository\n2. Install [rust](https://www.rust-lang.org/tools/install) using rustup binary installer\n3. Install [mdbook-katex](https://github.com/lzanini/mdbook-katex) plugin following their README's Windows users section. Put `mdbook-katex.exe` into the root directory of this repository.\n4. Install [mdbook-numeq](https://github.com/yannickseurin/mdbook-numeq) plugin via `cargo install mdbook-numeq`\n5. Install [mdbook-numthm](https://github.com/yannickseurin/mdbook-numthm) plugin via `cargo install mdbook-numthm`\n6. Install [mdbook-bib](https://github.com/francisco-perez-sorrosal/mdbook-bib) plugin via `cargo install mdbook-bib`\n7. Init, build, and view the online book following https://rust-lang.github.io/mdBook/cli/index.html. For example, you can simply do in a windows cmd: `mdbook.exe serve --open`\n\nMore useful tools for enhancing the book: https://github.com/rust-lang/mdBook/wiki\n","funding_links":[],"categories":["TeX","Handlebars"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphys-sim-book%2Fmdbook-src","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphys-sim-book%2Fmdbook-src","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphys-sim-book%2Fmdbook-src/lists"}