Repository: MrNeRF/awesome-3D-gaussian-splatting Branch: main Commit: c692febe4ec8 Files: 40 Total size: 2.4 MB Directory structure: gitextract__e_uw1ef/ ├── .gitattributes ├── .github/ │ ├── CODEOWNERS │ ├── FUNDING.yml │ └── workflows/ │ ├── generate-html.yml │ └── validate-pr.yml ├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── awesome_3dgs_papers.yaml ├── editor.py ├── index.html ├── requirements.txt └── src/ ├── __init__.py ├── arxiv_integration.py ├── components/ │ ├── __init__.py │ ├── dialogs.py │ ├── thumbnail.py │ └── widgets.py ├── fix_date.py ├── generate.py ├── helper.py ├── paper_generator.py ├── paper_schema.py ├── static/ │ ├── css/ │ │ ├── base.css │ │ ├── components.css │ │ └── responsive.css │ └── js/ │ ├── filters.js │ ├── main.js │ ├── navigation.js │ ├── selection.js │ ├── sharing.js │ ├── state.js │ └── utils.js ├── template_engine.py ├── templates/ │ ├── index.html │ └── paper_card.html ├── utils.py ├── validate_yaml.py └── yaml_editor.py ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitattributes ================================================ assets filter=lfs diff=lfs merge=lfs -text ================================================ FILE: .github/CODEOWNERS ================================================ # Require review for all changes * @MrNeRF ================================================ FILE: .github/FUNDING.yml ================================================ ================================================ FILE: .github/workflows/generate-html.yml ================================================ name: Generate HTML on: pull_request: types: [closed] push: branches: [main] paths: - 'awesome_3dgs_papers.yaml' jobs: build: if: github.event.pull_request.merged == true || github.event_name == 'push' runs-on: ubuntu-latest permissions: contents: write pull-requests: write steps: - uses: actions/checkout@v3 with: fetch-depth: 0 ref: main - name: Set up Python uses: actions/setup-python@v4 with: python-version: '3.10' - name: Install dependencies run: | python -m pip install --upgrade pip pip install -r requirements.txt - name: Setup Git run: | git config --global user.name 'github-actions[bot]' git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com' - name: Update HTML run: | git fetch origin update-html || true git checkout -B update-html python src/generate.py awesome_3dgs_papers.yaml index.html git add index.html if ! git diff --staged --quiet; then git commit -m "Update generated HTML" git push --force origin update-html fi - name: Create Pull Request uses: actions/github-script@v6 with: script: | const { data: pulls } = await github.rest.pulls.list({ owner: context.repo.owner, repo: context.repo.repo, head: `${context.repo.owner}:update-html`, base: 'main', state: 'open' }); if (pulls.length === 0) { await github.rest.pulls.create({ owner: context.repo.owner, repo: context.repo.repo, head: 'update-html', base: 'main', title: 'Update generated HTML', body: 'Auto-generated PR to update the HTML based on recent YAML changes.' }); } ================================================ FILE: .github/workflows/validate-pr.yml ================================================ name: Validate PR Changes on: pull_request: branches: [ main ] paths: - 'awesome_3dgs_papers.yaml' jobs: validate: runs-on: ubuntu-latest permissions: pull-requests: read contents: read steps: - uses: actions/checkout@v3 with: fetch-depth: 0 - name: Set up Python uses: actions/setup-python@v4 with: python-version: '3.10' - name: Install dependencies run: | python -m pip install --upgrade pip pip install -r requirements.txt - name: Validate Changed YAML entries env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} PR_NUMBER: ${{ github.event.pull_request.number }} REPO: ${{ github.repository }} run: | python src/validate_yaml.py ================================================ FILE: .gitignore ================================================ .venv __pycache__/ *.pyc ================================================ FILE: CONTRIBUTING.md ================================================ # Contributing Guide Thank you for your interest in contributing to the Awesome 3D Gaussian Splatting repository! This document will guide you through the contribution process. ## Adding Papers We use a custom YAML editor to maintain the paper database. To add or edit papers: 1. Clone the repository: ```bash git clone https://github.com/MrNeRF/awesome-3D-gaussian-splatting.git cd awesome-3D-gaussian-splatting ``` 2. Install dependencies: ```bash pip install -r requirements.txt ``` 3. Install Poppler (required for PDF processing): - **Ubuntu/Debian:** ```bash sudo apt-get install poppler-utils ``` - **macOS:** ```bash brew install poppler ``` - **Windows:** - Download and install from: https://github.com/oschwartz10612/poppler-windows/releases/ - Add the `bin` directory to your system PATH 4. Run the YAML editor: ```bash python src/yaml_editor.py ``` 5. Use the editor to: - Add new papers using the "Add from arXiv" button - Edit existing entries - Add tags, links, and other metadata - Preview thumbnails 6. The editor will automatically save changes to `awesome_3dgs_papers.yaml` ## Adding Other Resources For adding other resources (implementations, tools, tutorials, etc.): 1. Fork the repository 2. Create a new branch (`git checkout -b feature/new-resource`) 3. Edit the README.md file 4. Commit your changes (`git commit -m 'Add new resource'`) 5. Push to your fork (`git push origin feature/new-resource`) 6. Open a Pull Request Please ensure your additions: - Are related to 3D Gaussian Splatting - Have working links - Are placed in the appropriate section - Follow the existing formatting --- By contributing to this repository, you agree to abide by its terms and conditions. ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2023 janusch Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: README.md ================================================ # Awesome 3D Gaussian Splatting
If you find this resource helpful, consider supporting its development and maintenance.
Search: Enter paper title or author names, then click to clear.
Year: Filter by publication year
Tags: Click once to include (blue), twice to exclude (red), third time to remove filter
Selection: Use selection mode to pick and share specific papers
If you find this resource helpful, consider supporting its development and maintenance.
Search: Enter paper title or author names, then click to clear.
Year: Filter by publication year
Tags: Click once to include (blue), twice to exclude (red), third time to remove filter
Selection: Use selection mode to pick and share specific papers