Merge branch 'main' into main

.github/workflows/core_code_checks.yml

@@ -32,10 +32,10 @@ jobs:
       - name: Check notebook cell metadata
         run: |
           python ./nerfstudio/scripts/docs/add_nb_tags.py --check
-      - name: Run Ruff
-        run: ruff docs/ nerfstudio/ tests/
-      - name: Run Black
-        run: black docs/ nerfstudio/ tests/ --check
+      - name: Run Ruff Linter
+        run: ruff check docs/ nerfstudio/ tests/ --output-format=github
+      - name: Run Ruff Formatter
+        run: ruff format docs/ nerfstudio/ tests/ --diff
       - name: Run Pyright
         run: |
           pyright

.pre-commit-config.yaml

@@ -12,16 +12,15 @@ repos:
         files: '.*'
         pass_filenames: false
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v4.5.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
 -   repo: https://github.com/charliermarsh/ruff-pre-commit
-    # Ruff version.
-    rev: 'v0.0.267'
+    rev: v0.1.13
     hooks:
     -   id: ruff
--   repo: https://github.com/psf/black
-    rev: '23.3.0'
-    hooks:
-    -   id: black
+        types_or: [ python, pyi, jupyter ]
+        args: [ --fix ]
+    -   id: ruff-format
+        types_or: [ python, pyi, jupyter ]

.vscode/settings.json

@@ -24,16 +24,16 @@
   "typescript.suggestionActions.enabled": false,
   "javascript.suggestionActions.enabled": false,
   "[python]": {
-    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.defaultFormatter": "charliermarsh.ruff",
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true,
-      "source.fixAll": true
+      "source.organizeImports": "explicit",
+      "source.fixAll": "explicit"
     }
   },
   "editor.formatOnSave": true,
+  "editor.rulers": [120],
   "python.envFile": "${workspaceFolder}/.env",
   "python.formatting.provider": "none",
-  "black-formatter.args": ["--line-length=120"],
   "python.linting.pylintEnabled": false,
   "python.linting.flake8Enabled": false,
   "python.linting.enabled": true,

README.md

@@ -9,8 +9,6 @@
     <!-- code check badges -->
     <a href='https://github.com/nerfstudio-project/nerfstudio/actions/workflows/core_code_checks.yml'>
         <img src='https://github.com/nerfstudio-project/nerfstudio/actions/workflows/core_code_checks.yml/badge.svg' alt='Test Status' /></a>
-    <a href='https://github.com/nerfstudio-project/nerfstudio/actions/workflows/viewer_build_deploy.yml'>
-        <img src='https://github.com/nerfstudio-project/nerfstudio/actions/workflows/viewer_build_deploy.yml/badge.svg' alt='Viewer build Status' /></a>
     <!-- license badge -->
     <a href="https://github.com/nerfstudio-project/nerfstudio/blob/master/LICENSE">
         <img alt="License" src="https://img.shields.io/badge/License-Apache_2.0-blue.svg"></a>

colab/demo.ipynb

@@ -3,8 +3,8 @@
     {
       "cell_type": "markdown",
       "metadata": {
-        "id": "view-in-github",
-        "colab_type": "text"
+        "colab_type": "text",
+        "id": "view-in-github"
       },
       "source": [
         "<a href=\"https://colab.research.google.com/github/nerfstudio-project/nerfstudio/blob/alex%2Fcolab-logo-fix/colab/demo.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
@@ -65,8 +65,8 @@
       "cell_type": "code",
       "execution_count": null,
       "metadata": {
-        "id": "9oyLHl8QfYwP",
-        "cellView": "form"
+        "cellView": "form",
+        "id": "9oyLHl8QfYwP"
       },
       "outputs": [],
       "source": [
@@ -83,28 +83,7 @@
         "\n",
         "# Installing COLMAP\n",
         "%cd /content/\n",
-        "!gdown \"https://drive.google.com/u/0/uc?id=15WngFRNar_b8CaPR5R-hvQ3eAnlyk_SL&confirm=t\"\n",
-        "!sudo apt-get install \\\n",
-        "    build-essential \\\n",
-        "    libboost-program-options-dev \\\n",
-        "    libboost-filesystem-dev \\\n",
-        "    libboost-graph-dev \\\n",
-        "    libboost-system-dev \\\n",
-        "    libboost-test-dev \\\n",
-        "    libeigen3-dev \\\n",
-        "    libflann-dev \\\n",
-        "    libfreeimage-dev \\\n",
-        "    libmetis-dev \\\n",
-        "    libgoogle-glog-dev \\\n",
-        "    libgflags-dev \\\n",
-        "    libsqlite3-dev \\\n",
-        "    libglew-dev \\\n",
-        "    qtbase5-dev \\\n",
-        "    libqt5opengl5-dev \\\n",
-        "    libcgal-dev \\\n",
-        "    libceres-dev\n",
-        "!unzip local.zip -d /usr/\n",
-        "!chmod +x /usr/local/bin/colmap\n",
+        "!apt-get install colmap\n",
         "\n",
         "# Install nerfstudio\n",
         "%cd /content/\n",
@@ -350,8 +329,8 @@
   "metadata": {
     "accelerator": "GPU",
     "colab": {
-      "provenance": [],
-      "include_colab_link": true
+      "include_colab_link": true,
+      "provenance": []
     },
     "gpuClass": "standard",
     "kernelspec": {
@@ -371,4 +350,4 @@
   },
   "nbformat": 4,
   "nbformat_minor": 0
-}
+}

docs/extensions/blender_addon.md

@@ -6,7 +6,7 @@
 
 ## Overview
 
-This Blender add-on allows for compositing with a Nerfstudio render as a background layer by generating a camera path JSON file from the Blender camera path, as well as a way to import Nerfstudio JSON files as a Blender camera baked with the Nerfstudio camera path. This add-on also allows compositing multiple NeRF objects into a NeRF scene. This is achieved by importing a mesh or point-cloud representation of the NeRF scene from Nerfstudio into Blender and getting the camera coordinates relative to the transformations of the NeRF representation. Dynamic FOV from the Blender camera is supported and will match the Nerfstudio render. Perspective, equirectangular, VR180, and omnidirectional stereo (VR 360) cameras are supported.
+This Blender add-on allows for compositing with a Nerfstudio render as a background layer by generating a camera path JSON file from the Blender camera path, as well as a way to import Nerfstudio JSON files as a Blender camera baked with the Nerfstudio camera path. This add-on also allows compositing multiple NeRF objects into a NeRF scene. This is achieved by importing a mesh or point-cloud representation of the NeRF scene from Nerfstudio into Blender and getting the camera coordinates relative to the transformations of the NeRF representation. Dynamic FOV from the Blender camera is supported and will match the Nerfstudio render. Perspective, equirectangular, VR180, and omnidirectional stereo (VR 360) cameras are supported. This add-on also supports Gaussian Splatting scenes as well, however equirectangular and VR video rendering is not currently supported for splats.
 
 <center>
  <img width="800" alt="image" src="https://user-images.githubusercontent.com/9502341/211442247-99d1ebc7-3ef9-46f7-9bcc-0e18553f19b7.PNG">
@@ -30,7 +30,7 @@ This Blender add-on allows for compositing with a Nerfstudio render as a backgro
 
 ## Scene Setup
 
-1. Export the mesh or point cloud representation of the NeRF from Nerfstudio, which will be used as reference for the actual NeRF in the Blender scene. Mesh export at a good quality is preferred, however, if the export is not clear or the NeRF is large, a detailed point cloud export will also work.
+1. Export the mesh or point cloud representation of the NeRF from Nerfstudio, which will be used as reference for the actual NeRF in the Blender scene. Mesh export at a good quality is preferred, however, if the export is not clear or the NeRF is large, a detailed point cloud export will also work. Keep the `save_world_frame` flag as False or in the viewer, de-select the "Save in world frame" checkbox to keep the correct coordinate system for the add-on.
 
 2. Import the mesh or point cloud representation of the NeRF into the scene. You may need to crop the mesh further. Since it is used as a reference and won't be visible in the final render, only the parts that the blender animation will interact with may be necessary to import.
 
@@ -109,6 +109,7 @@ This Blender add-on allows for compositing with a Nerfstudio render as a backgro
     <img width="300" alt="image" src="https://github-production-user-asset-6210df.s3.amazonaws.com/9502341/253217833-fd607601-2b81-48ab-ac5d-e55514a588da.png">
     </center>
 - Fisheye and orthographic cameras are not supported.
+- Renders with Gaussian Splats are supported, but the point cloud or mesh representation would need to be generated from training a NeRF on the same dataset.
 - A walkthrough of this section is included in the tutorial video.
 
 ## Create Blender Camera from Nerfstudio JSON Camera Path

docs/index.md

@@ -82,6 +82,7 @@ We hope nerfstudio enables you to build faster 🔨 learn together 📚 and cont
 
 quickstart/installation
 quickstart/first_nerf
+quickstart/existing_dataset
 quickstart/custom_dataset
 quickstart/viewer_quickstart
 quickstart/export_geometry
@@ -140,6 +141,7 @@ This documentation is organized into 3 parts:
 - [NeRF](nerfology/methods/nerf.md): OG Neural Radiance Fields
 - [Mip-NeRF](nerfology/methods/mipnerf.md): A Multiscale Representation for Anti-Aliasing Neural Radiance Fields
 - [TensoRF](nerfology/methods/tensorf.md): Tensorial Radiance Fields
+- [Splatfacto](nerfology/methods/splat.md): Nerfstudio's Gaussian Splatting implementation
 
 (third_party_methods)=
 
@@ -153,6 +155,7 @@ This documentation is organized into 3 parts:
 - [Tetra-NeRF](nerfology/methods/tetranerf.md): Representing Neural Radiance Fields Using Tetrahedra
 - [Instruct-GS2GS](nerfology/methods/igs2gs.md): Editing 3DGS Scenes with Instructions
 - [PyNeRF](nerfology/methods/pynerf.md): Pyramidal Neural Radiance Fields
+- [SeaThru-NeRF](nerfology/methods/seathru_nerf.md): Neural Radiance Field for subsea scenes
 
 **Eager to contribute a method?** We'd love to see you use nerfstudio in implementing new (or even existing) methods! Please view our {ref}`guide<own_method_docs>` for more details about how to add to this list!
 

docs/nerfology/methods/index.md

@@ -27,6 +27,7 @@ The following methods are supported in nerfstudio:
 ```{toctree}
     :maxdepth: 1
     Instant-NGP<instant_ngp.md>
+    Splatfacto<splat.md>
     Instruct-NeRF2NeRF<in2n.md>
     K-Planes<kplanes.md>
     LERF<lerf.md>
@@ -40,6 +41,7 @@ The following methods are supported in nerfstudio:
     Generfacto<generfacto.md>
     Instruct-GS2GS<igs2gs.md>
     PyNeRF<pynerf.md>
+    SeaThru-NeRF<seathru_nerf.md>
 ```
 
 (own_method_docs)=