V0.9.0 Release

.github/workflows/ci.yml

@@ -11,8 +11,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        numpy-version: ["oldest-supported-numpy", "numpy"]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+        numpy-version: ["numpy"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
     - name: Checkout code
       uses: actions/checkout@v4
@@ -21,8 +21,8 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Python dependencies
-      run: python -m pip install --prefer-binary setuptools "cython>=0.28,<3.0" "matplotlib>=3,<4" ${{ matrix.numpy-version }}
+      run: python -m pip install --prefer-binary meson-python meson ninja setuptools setuptools-scm "cython>=3.1" "matplotlib>=3,<4" ${{ matrix.numpy-version }}
     - name: Build and install Raysect
-      run: dev/build.sh
+      run: dev/install_editable.sh
     - name: Run tests
       run: dev/test.sh

.gitignore

@@ -6,10 +6,12 @@ __pycache__/
 # C extensions
 *.so
 *.c
+
 # Distribution / packaging
+/build/
 .Python
 env/
-build/
+venv/
 develop-eggs/
 dist/
 downloads/
@@ -58,4 +60,5 @@ docs/build/
 # PyBuilder
 target/
 
-
+# setuptools-scm
+raysect/_version.py

CHANGELOG.txt

@@ -1,6 +1,32 @@
 Raysect Changelog
 =================
 
+Release 0.9.0 (TBD)
+-------------------
+
+Build changes:
+* The legacy setuptools build system has been replaced with meson-python.
+  - The dev/build.sh and dev/clean.sh scripts have been updated to work with the new build system.
+  - A meson.build generator script is provided to automate the discovery of pyx, pxd,py and data files. Please see dev/generate_meson_files.py.
+  - When installed in editable mode, any modified pyx files will automatically trigger a rebuild when python attempts to import from the package. Please be aware that (as with the previous build system) changes to pxd files will require a clean rebuild of the project.
+  - A dev/install_editable.sh script is provided to simplify the installation of the package in editable mode with verbose build output enabled.
+  - Meson-python performs the build out of the project folder, so the project source folders will no longer be polluted with build artefacts.
+  - Cython build annotations are now always enabled, the annotation files can be found in the build folder under the build artefacts folder associated with each so file (*.so.p folder).
+* The codebase has been migrated to Cython 3.
+  - This migration was made possible due to the contributions of Koyo Munechika (@munechika-koyo).
+
+Python support:
+* Raysect now requires Python v3.9 and above.
+  - From version v0.9.0 Raysect is dropping support for Python versions older than v3.9.
+  - Users of older versions of Python should remain using Raysect v0.8.1 and plan for a migration to v0.9.0+.
+
+API changes:
+* Corrected spelling of all classes, methods and functions where "targeted" was incorrectly spelt "targetted".
+
+New:
+* Added a torus primitive (contribute by Koyo Munechika).
+
+
 Release 0.8.1 (12 Feb 2023)
 ---------------------------
 

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2021, Dr Alex Meakins, Raysect Project
+Copyright (c) 2014-2025, Dr Alex Meakins, Raysect Project
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,5 +1,4 @@
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1341346.svg)](https://doi.org/10.5281/zenodo.1341346)
-[![Build Status](https://travis-ci.com/raysect/source.svg?branch=master)](https://travis-ci.com/raysect/source)
 
 <a name="logo"/>
 <a href="https://www.raysect.org/" target="_blank">

demos/materials/modifiers/transform.py

@@ -18,7 +18,7 @@ def emission_function(self, point, direction, spectrum, world, ray, primitive, t
         wvl_range = spectrum.min_wavelength - spectrum.max_wavelength
         shift = 2 * (spectrum.wavelengths - wvl_centre) / wvl_range
         radius = sqrt(point.x**2 + point.y**2)
-        spectrum.samples += cos((shift + 5) * radius)**4
+        spectrum.samples[:] += cos((shift + 5) * radius)**4
         return spectrum
 
 

demos/materials/volume.py

@@ -20,7 +20,7 @@ def emission_function(self, point, direction, spectrum, world, ray, primitive, t
         wvl_range = spectrum.min_wavelength - spectrum.max_wavelength
         shift = 2 * (spectrum.wavelengths - wvl_centre) / wvl_range
         radius = sqrt(point.x**2 + point.y**2)
-        spectrum.samples += cos((shift + 5) * radius)**4
+        spectrum.samples[:] += cos((shift + 5) * radius)**4
         return spectrum
 
 

demos/maths/plot_targetted_sampler.py → demos/maths/plot_targeted_sampler.py

@@ -2,7 +2,7 @@
 import matplotlib.pyplot as plt
 from math import atan2, sqrt, degrees
 
-from raysect.core.math import Point3D, TargettedHemisphereSampler, TargettedSphereSampler
+from raysect.core.math import Point3D, TargetedHemisphereSampler, TargetedSphereSampler
 
 
 def display_samples(samples, title):
@@ -34,8 +34,8 @@ def display_samples(samples, title):
 observation_point = Point3D(0, 0, 0)
 
 # generate samplers
-hemisphere = TargettedHemisphereSampler(targets)
-sphere = TargettedSphereSampler(targets)
+hemisphere = TargetedHemisphereSampler(targets)
+sphere = TargetedSphereSampler(targets)
 
 # sample for origin point and point at (0, 0, -10)
 h_samples = hemisphere(observation_point, samples=samples)

demos/observers/cornell_box_cooke_triplet.py

@@ -4,7 +4,7 @@
 from raysect.optical import World, Node, translate, rotate, Point3D
 from raysect.optical.material import Lambert, UniformSurfaceEmitter, AbsorbingSurface, Checkerboard
 from raysect.optical.library import *
-from raysect.optical.observer import TargettedCCDArray
+from raysect.optical.observer import TargetedCCDArray
 from raysect.optical.observer import RGBPipeline2D, BayerPipeline2D, PowerPipeline2D
 from raysect.optical.observer import RGBAdaptiveSampler2D
 from raysect.core.math import mm
@@ -184,9 +184,9 @@
 rgb = RGBPipeline2D(display_unsaturated_fraction=0.96, name="sRGB")
 sampler = RGBAdaptiveSampler2D(rgb, ratio=10, fraction=0.2, min_samples=1000, cutoff=0.01)
 
-# CCD targetting all rays at last lens element for speed
-ccd = TargettedCCDArray(
-    targetted_path_prob=1.0, targets=[l3],
+# CCD targeting all rays at last lens element for speed
+ccd = TargetedCCDArray(
+    targeted_path_prob=1.0, targets=[l3],
     width=mm(35), pixels=(512, 512),
     parent=image_plane, transform=translate(0, 0, 0)*rotate(0, 0, 180),
     pipelines=[rgb]

demos/observers/cornell_box_real_pinhole.py

@@ -5,7 +5,7 @@
 from raysect.optical import World, Node, translate, rotate, Point3D
 from raysect.optical.material import Lambert, UniformSurfaceEmitter, NullMaterial
 from raysect.optical.library import *
-from raysect.optical.observer import RGBPipeline2D, BayerPipeline2D, PowerPipeline2D, TargettedCCDArray
+from raysect.optical.observer import RGBPipeline2D, BayerPipeline2D, PowerPipeline2D, TargetedCCDArray
 from raysect.optical.observer import RGBAdaptiveSampler2D
 
 
@@ -144,7 +144,7 @@
 
 camera = Node(parent=world, transform=translate(0, 0, -3.3))
 pinhole = Sphere(0.0005, camera, transform=translate(0, 0, 0), material=NullMaterial())
-film = TargettedCCDArray(targetted_path_prob=1.0, targets=[pinhole], width=0.1, pixels=(512, 512), parent=camera,
+film = TargetedCCDArray(targeted_path_prob=1.0, targets=[pinhole], width=0.1, pixels=(512, 512), parent=camera,
                          transform=translate(0, 0, -0.1207), pipelines=pipelines)
 film.frame_sampler = sampler
 film.pixel_samples = 250

demos/observers/metal_with_lens.py

@@ -7,7 +7,7 @@
 from raysect.optical.library.metal import Gold, Silver, Copper, Titanium, Aluminium, Beryllium
 from raysect.optical.material import Lambert, UniformSurfaceEmitter, AbsorbingSurface, NullMaterial
 from raysect.optical.library import schott
-from raysect.optical.observer import RGBPipeline2D, BayerPipeline2D, TargettedCCDArray, CCDArray, RGBAdaptiveSampler2D
+from raysect.optical.observer import RGBPipeline2D, BayerPipeline2D, TargetedCCDArray, CCDArray, RGBAdaptiveSampler2D
 from raysect.optical.colour import ciexyz_x, ciexyz_y, ciexyz_z
 
 
@@ -49,7 +49,7 @@
 pipelines = [rgb, bayer]
 
 # ccd = CCDArray(parent=camera, pipelines=pipelines)
-ccd = TargettedCCDArray(targets=[aperture], parent=camera, pipelines=pipelines)
+ccd = TargetedCCDArray(targets=[aperture], parent=camera, pipelines=pipelines)
 ccd.frame_sampler = sampler
 ccd.pixels = (180*2, 120*2)  # (360, 240)
 ccd.pixel_samples = 250
@@ -65,3 +65,6 @@
     # ccd.pipelines[0].save("demo_metal_lens_{}.png".format(p))
     print()
     p += 1
+
+ioff()
+show()

demos/observers/targetted_pixel.py → demos/observers/targeted_pixel.py

@@ -3,7 +3,7 @@
 
 from raysect.primitive import Box
 from raysect.optical import World, translate, Point3D, Node
-from raysect.optical.observer import Pixel, TargettedPixel, PowerPipeline0D
+from raysect.optical.observer import Pixel, TargetedPixel, PowerPipeline0D
 from raysect.optical.material import UnitySurfaceEmitter
 
 
@@ -28,16 +28,16 @@
 basic_pipeline = PowerPipeline0D(name="Basic Pixel Observer")
 basic_pixel = Pixel(parent=world, pixel_samples=SAMPLES, pipelines=[basic_pipeline])
 
-# setup targetted pixel
-targetted_pipeline = PowerPipeline0D(name="Targeted Pixel Observer")
-targetted_pixel = TargettedPixel(parent=world, targets=targets, pixel_samples=SAMPLES, pipelines=[targetted_pipeline])
-targetted_pixel.targetted_path_prob = 1
+# setup targeted pixel
+targeted_pipeline = PowerPipeline0D(name="Targeted Pixel Observer")
+targeted_pixel = TargetedPixel(parent=world, targets=targets, pixel_samples=SAMPLES, pipelines=[targeted_pipeline])
+targeted_pixel.targeted_path_prob = 1
 
 # render
 ion()
 basic_pixel.observe()
 print()
-targetted_pixel.observe()
+targeted_pixel.observe()
 
 ioff()
 show()

demos/optics/etendue_of_pinhole.py

@@ -3,7 +3,7 @@
 import matplotlib.pyplot as plt
 
 from raysect.core import Point3D, Vector3D, rotate_basis, translate, Ray as CoreRay
-from raysect.core.math.sampler import DiskSampler3D, RectangleSampler3D, TargettedHemisphereSampler
+from raysect.core.math.sampler import DiskSampler3D, RectangleSampler3D, TargetedHemisphereSampler
 from raysect.optical import World
 from raysect.primitive import Box, Cylinder, Subtract
 from raysect.optical.material import AbsorbingSurface, NullMaterial
@@ -35,8 +35,8 @@ def raytraced_etendue(distance, detector_radius=0.001, ray_count=100000, batches
     sphere = target.bounding_sphere()
     spheres = [(sphere.centre.transform(detector_transform), sphere.radius, 1.0)]
 
-    # instance targetted pixel sampler
-    targetted_sampler = TargettedHemisphereSampler(spheres)
+    # instance targeted pixel sampler
+    targeted_sampler = TargetedHemisphereSampler(spheres)
 
     point_sampler = DiskSampler3D(detector_radius)
 
@@ -53,8 +53,8 @@ def raytraced_etendue(distance, detector_radius=0.001, ray_count=100000, batches
         passed = 0.0
         for origin in origins:
 
-            # obtain targetted vector sample
-            direction, pdf = targetted_sampler(origin, pdf=True)
+            # obtain targeted vector sample
+            direction, pdf = targeted_sampler(origin, pdf=True)
             path_weight = R_2_PI * direction.z/pdf
 
             origin = origin.transform(detector_transform)
@@ -110,12 +110,10 @@ def raytraced_etendue(distance, detector_radius=0.001, ray_count=100000, batches
 raytraced_values = np.array(raytraced_values)
 raytraced_errors = np.array(raytraced_errors)
 
-plt.ion()
-
 plt.figure()
 ax = plt.gca()
-ax.set_xscale("log", nonposx='clip')
-ax.set_yscale("log", nonposy='clip')
+ax.set_xscale("log", nonpositive='clip')
+ax.set_yscale("log", nonpositive='clip')
 plt.axhline(y=detector_etendue, linestyle='--', color='k', label='detector etendue')
 plt.plot(distance_samples, analytic_values, label='analytic etendue')
 plt.errorbar(distance_samples, raytraced_values, raytraced_errors, label='ray-traced etendue')
@@ -126,12 +124,11 @@ def raytraced_etendue(distance, detector_radius=0.001, ray_count=100000, batches
 
 # plt.figure()
 # ax = plt.gca()
-# ax.set_xscale("log", nonposx='clip')
+# ax.set_xscale("log", nonpositive='clip')
 # plt.errorbar(distance_samples, np.abs(raytraced_values-analytic_values)/raytraced_values, raytraced_errors/raytraced_values)
 # plt.xlim(0.001, 0.1)
 # plt.ylim(0, 0.5)
 # plt.xlabel('Distance between slit and detector (m)')
 # plt.ylabel('Fractional error')
-# plt.show()
-
 
+plt.show()

demos/optics/logging_trajectories.py

@@ -28,8 +28,7 @@
 
 # for each sample direction trace a logging ray and plot the ray trajectory
 plt.ion()
-fig = plt.figure()
-ax = fig.gca(projection='3d')
+ax = plt.axes(projection='3d')
 
 for u in np.linspace(-0.006, 0.006, 5):
     for v in np.linspace(-0.012, 0.012, 11):
@@ -39,7 +38,8 @@
         log_ray.trace(world)
 
         p = [(start.x, start.y, start.z)]
-        for point in log_ray.log:
+        for intersection in log_ray.log:
+            point = intersection.hit_point
             p.append((point.x, point.y, point.z))
         p = np.array(p)