Bump version to 0.3.0 in Project.toml

Update README.md Add media for notebook examples Fix typo in custom-material-example.jl Update dependencies in Project.toml files Update Julia setup actions in CI and Documentation workflows Update notebook examples
dominic-chang · Oct 12, 2024 · 57bf646 · 57bf646 · dominic-chang · Oct 12, 2024
1 parent 18bb85f
commit 57bf646
Show file tree

Hide file tree

Showing 18 changed files with 20 additions and 22 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -26,11 +26,11 @@ jobs:
           - x64
     steps:
       - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: julia-actions/cache@v1
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1

diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
@@ -7,8 +7,6 @@ jobs:
   CompatHelper:
     runs-on: ubuntu-latest
     steps:
-      - name: Install JacobiElliptic
-        run: julia --project -e 'using Pkg; Pkg.develop([PackageSpec(path="https://github.com/dchang10/JacobiElliptic.jl.git")]); Pkg.instantiate()'
       - name: Pkg.add("CompatHelper")
         run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
       - name: CompatHelper.main()

diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -33,11 +33,11 @@ jobs:
       - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
       - run: cd docs/; rm package-lock.json; npm install; cd ..
       - name: Setup Julia
-        uses: julia-actions/setup-julia@v1
+        uses: julia-actions/setup-julia@v2
         with:
           version: '1.10'
       - name: Pull Julia cache
-        uses: julia-actions/cache@v1
+        uses: julia-actions/cache@v2
       - name: Install docs dependencies
         run: julia --project=docs -e 'using Pkg; Pkg.develop([PackageSpec(path=pwd()), PackageSpec(path="https://github.com/LuxDL/DocumenterVitepress.jl.git")]); Pkg.instantiate()'
       - name: Install examples dependencies

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "Krang"
 uuid = "54806c32-d51a-438d-8447-e0041be2fbfb"
 authors = ["Dominic <[email protected]> and contributors"]
-version = "0.2.3"
+version = "0.3.0"
 
 [deps]
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"

diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ These considerations allow our algorithms to be easily used in Machine Learning
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://dominic-chang.github.io/Krang.jl/dev/)
 ## Repo Status
 [![Build Status](https://github.com/dominic-chang/Krang.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/dchang10/Krang.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
 [![Coverage](https://codecov.io/gh/dominic-chang/Krang.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/dchang10/Krang.jl)
 # Installation
 Launch your Julia session with then type `]` to move into Pkg mode. Once in pkg mode type

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -23,3 +23,6 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 
 [compat]
 Enzyme = "0.13"
+Lux = "1.1"
+Optimization = "4.0"
+OptimizationOptimisers = "0.3"
diff --git a/examples/Project.toml b/examples/Project.toml
@@ -11,6 +11,7 @@ GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
 JacobiElliptic = "2a8b799e-c098-4961-872a-356c768d184c"
 KernelAbstractions = "63c18a36-062a-441e-b654-da1e3ab1ce7c"
 Krang = "54806c32-d51a-438d-8447-e0041be2fbfb"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 Lux = "b2108857-7c20-44ae-9111-449ecde12c47"
 NPZ = "15e1cf62-19b3-5cfa-8e77-841668bca605"
 Optimization = "7f7a1694-90dd-40f0-9382-eb1efda571ba"
@@ -25,3 +26,6 @@ WGLMakie = "276b4fcb-3e11-5398-bf8b-a0c2d153d008"
 
 [compat]
 Enzyme = "0.13"
+Lux = "1.1"
+Optimization = "4.0"
+OptimizationOptimisers = "0.3"
diff --git a/examples/custom-material-example.jl b/examples/custom-material-example.jl
@@ -35,7 +35,7 @@ function (m::ZAMORedshifts)(pix::Krang.AbstractPixel, geometry::Krang.ConeGeomet
             p_zamo_u = jac_zamo_u_bl_d(metric, rs, θs) * curr_p_bl_u
             redshift = inv(p_zamo_u[1])
 
-            observation = max(redshift, eps(T))^(T(3))
+            observation = max(redshift, eps(T))
         end
     end
     return observation

diff --git a/examples/raytracing-mesh-example.jl b/examples/raytracing-mesh-example.jl
@@ -59,7 +59,7 @@ sphere = GLMk.Sphere(GLMk.Point(0.0,0.0,0.0), horizon(metric)) # Sphere to repre
 lines_to_plot = Krang.generate_ray.(camera.screen.pixels, 100) # 100 is the number of steps to take along the ray
 
 img = zeros(sze, sze)
-recording = GLMk.record(fig, "mesh.mp4", 1:sze*sze, framerate=400) do i
+recording = GLMk.record(fig, "mesh.mp4", 1:sze*sze, framerate=120) do i
     line = lines_to_plot[i] 
 
     img[i] = intersections[i]

diff --git a/notebook_examples/coordinate.gif b/notebook_examples/coordinate.gif
diff --git a/notebook_examples/custom-material-example.ipynb b/notebook_examples/custom-material-example.ipynb
@@ -72,7 +72,7 @@
     "            p_zamo_u = jac_zamo_u_bl_d(metric, rs, θs) * curr_p_bl_u\n",
     "            redshift = inv(p_zamo_u[1])\n",
     "\n",
-    "            observation = max(redshift, eps(T))^(T(3))\n",
+    "            observation = max(redshift, eps(T))\n",
     "        end\n",
     "    end\n",
     "    return observation\n",
@@ -115,7 +115,7 @@
     {
      "output_type": "execute_result",
      "data": {
-      "text/plain": "(Krang.Mesh{Krang.ConeGeometry{Float64, Nothing}, Main.var\"##239\".ZAMORedshifts{Float64}}(Krang.ConeGeometry{Float64, Nothing}(1.3089969389957472, nothing), Main.var\"##239\".ZAMORedshifts{Float64}(1, 1.141067359796659, 10.0)),)"
+      "text/plain": "(Krang.Mesh{Krang.ConeGeometry{Float64, Nothing}, Main.var\"##131077\".ZAMORedshifts{Float64}}(Krang.ConeGeometry{Float64, Nothing}(1.3089969389957472, nothing), Main.var\"##131077\".ZAMORedshifts{Float64}(1, 1.141067359796659, 10.0)),)"
      },
      "metadata": {},
      "execution_count": 5
@@ -146,14 +146,6 @@
       "┌ Warning: Found `resolution` in the theme when creating a `Scene`. The `resolution` keyword for `Scene`s and `Figure`s has been deprecated. Use `Figure(; size = ...` or `Scene(; size = ...)` instead, which better reflects that this is a unitless size and not a pixel resolution. The key could also come from `set_theme!` calls or related theming functions.\n",
       "└ @ Makie ~/.julia/packages/Makie/YkotL/src/scenes.jl:229\n"
      ]
-    },
-    {
-     "output_type": "execute_result",
-     "data": {
-      "text/plain": "CairoMakie.Screen{IMAGE}\n"
-     },
-     "metadata": {},
-     "execution_count": 6
     }
    ],
    "cell_type": "code",

diff --git a/notebook_examples/emission_model_and_image_model.png b/notebook_examples/emission_model_and_image_model.png
diff --git a/notebook_examples/emission_model_and_target_model.png b/notebook_examples/emission_model_and_target_model.png
diff --git a/notebook_examples/mesh.mp4 b/notebook_examples/mesh.mp4
diff --git a/notebook_examples/neural-net-example.ipynb b/notebook_examples/neural-net-example.ipynb
@@ -214,7 +214,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "WARNING: using ComponentArrays.Axis in module ##242 conflicts with an existing identifier.\n"
+      "WARNING: using ComponentArrays.Axis in module ##131080 conflicts with an existing identifier.\n"
      ]
     }
    ],

diff --git a/notebook_examples/neural_net_results.png b/notebook_examples/neural_net_results.png
diff --git a/notebook_examples/raytracing-mesh-example.ipynb b/notebook_examples/raytracing-mesh-example.ipynb
diff --git a/notebook_examples/redshifts.png b/notebook_examples/redshifts.png