Merge pull request #16 from vye16/pre_release

Pre release refactorization

.github/workflows/core_tests.yml

@@ -0,0 +1,26 @@
+name: Core Tests.
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.8.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.8.12"
+      - name: Install dependencies
+        run: |
+          pip install isort==5.10.1 black[jupyter]==22.3.0
+      - name: Run Black Format Check
+        run: black . diff_rast/ tests/ examples/ --check

.github/workflows/doc.yml

@@ -0,0 +1,35 @@
+name: Docs
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          pip install -r docs/requirements.txt
+          pip install torch==2.0.0 --index-url https://download.pytorch.org/whl/cpu
+          BUILD_NO_CUDA=1 pip install .
+      - name: Sphinx build
+        # fail on warnings: "-W --keep-going"
+        run: |
+          sphinx-build docs/source _build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true
+        #   cname: ...

.gitignore

@@ -117,12 +117,6 @@ venv.bak/
 # line_profiler
 *.lprof
 
-# vscode
-.vsocde
-
 *build
 compile_commands.json
-
-*.png
-*.txt
-*.dump
+*.dump

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "csrc/third_party/glm"]
-	path = csrc/third_party/glm
-	url = https://github.com/g-truc/glm.git
+[submodule "diff_rast/cuda/csrc/third_party/glm"]
+	path = diff_rast/cuda/csrc/third_party/glm
+	url = https://github.com/g-truc/glm.git

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include dir-pattern diff_rast/cuda/csrc

README.md

@@ -2,18 +2,25 @@
 
 Our version of differentiable gaussian rasterizer
 
-# ref_rast
+# Installation
 
-Copied official version of differentiable gaussian rasterizer
+For CUDA development, it is recommend to install with `BUILD_NO_CUDA=1`, which
+will disable compiling during pip install, and instead use JIT compiling on your
+first run. The benefit of JIT compiling is that it does incremental compiling as
+you modify your cuda code so it is much faster than re-compile through pip. Note
+the JIT compiled library can be found under `~/.cache/torch_extensions/py*-cu*/`.
 
-# Installation
+```
+BUILD_NO_CUDA=1 pip install -e .[dev]
+```
+
+If you won't touch the underlying CUDA code, you can just install with compiling:
 
 ```
-python3 -m pip install --upgrade pip
-cd diff_rast; pip install -e .
-cd ../ref_rast; pip install -e .
+pip install -e .[dev]
 ```
 
+
 # Brief walkthrough
 
 The main python bindings for rasterization are found by importing diff_rast
@@ -23,13 +30,6 @@ import diff_rast
 help(diff_rast)
 ```
 
-Additional supported cuda functions are found by importing cuda_lib
-
-```
-import cuda_lib
-help(cuda_lib)
-```
-
 # clangd setup (for Neovim)
 
 [clangd](https://clangd.llvm.org/) is a nice tool for providing completions,