signedmcrt

Use of signed distance fields in Monte Carlo Radiative Transfer

https://github.com/lewisfish/signedmcrt

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 12 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

fortran fortran-package-manager fpm light-transport mcrt monte-carlo-simulation radiation-transfer
Last synced: 6 months ago · JSON representation ·

Repository

Use of signed distance fields in Monte Carlo Radiative Transfer

Basic Info
  • Host: GitHub
  • Owner: lewisfish
  • License: mit
  • Language: Fortran
  • Default Branch: main
  • Homepage:
  • Size: 32.1 MB
Statistics
  • Stars: 10
  • Watchers: 2
  • Forks: 2
  • Open Issues: 1
  • Releases: 1
Topics
fortran fortran-package-manager fpm light-transport mcrt monte-carlo-simulation radiation-transfer
Created over 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

SignedMCRT logo made in signedMCRT

DOI codecov workflow License

view - Documentation

SignedMCRT

SignedMCRT is a Monte Carlo Radiation Transfer (MCRT) code that uses signed distance functions (SDF) to represent the geometry as opposed to the usual voxel or mesh represention. The use of SDFs allows modelling of smooth surfaces more accuratly than other methods.

Instructions

Code prerequisites: Fortran 2018 compliant complier e.g gfortran-9+ or intel oneAPI Fortran. Only tested on Linux and Mac. Unlikely to run on Windows without some changes.

To run the code you can use: - The Fortran package manager by running; "fpm run" for single core uage or "fpm @runmp" for multicore usage.

See this for more detailed instructions and details on the code and build systems used.

Publication

The code in this repo forms the basis for the following publications:

Paper describing operation of signedMCRT: https://doi.org/10.1117/1.JBO.27.8.083003

Paper describing of an application of signedMCRT: https://doi.org/10.1364/OE.451496

Data created with this code can be found at: https://doi.org/10.5281/zenodo.5780513

Example of SDF models produced by signedMCRT

SDF of University of St Andrews crest. SVG of crest was simplified in Inkscape and then exported using svg.f90 to line segments and assigned optical properties before being illuminated uniformly by light. Image of SDF model of university crest

Comparison of voxel and SDF models of a glass bottle with scattering contents. The voxel model exhibits un-physical reflections and refractions. Comparison of light distribution in voxel and SDF bottle

Comparison of voxel interpolated surface normals, mesh based Monte Carlo (MMC), and SDFs model of a sphere being illuminated by a tophat laser beam. Comparison of sMCRT to voxel and smoothed surface normal method

SDF information

List of SDF functions https://iquilezles.org/www/articles/distfunctions/distfunctions.htm

What can be modelled with SDF's https://iquilezles.org/www/articles/raymarchingdf/raymarchingdf.htm

Owner

  • Name: Lewis McMillan
  • Login: lewisfish
  • Kind: user
  • Location: United Kingdom
  • Company: St Andrews University

Postdoc at University of St Andrews. Love all things science and coding.

Citation (citation.cff)

authors:
  - family-names: McMillan
    given-names: Lewis
cff-version: 1.2.0
message: "If you use this software, please cite both the article from preferred-citation and the software itself."
preferred-citation:
  authors:
    - family-names: McMillan
      given-names: Lewis
      orcid: https://orcid.org/0000-0002-7725-5162
    - family-names: Bruce
      given-names: Graham D
      orcid: https://orcid.org/0000-0003-3403-0614
    - family-names: Dholakia
      given-names: Kishan
      orcid: https://orcid.org/0000-0001-6534-9009
  title: "Meshless Monte Carlo Radiation Transfer Method for Curved Geometries Using Signed Distance Functions"
  type: article
title: "Meshless Monte Carlo Radiation Transfer Method for Curved Geometries Using Signed Distance Functions"
version: 1.0.0
doi: 10.1364/OE.451496
date-released: 2023-01-13
url: "https://doi.org/10.1364/OE.451496"

GitHub Events

Total
  • Issue comment event: 1
  • Push event: 6
  • Pull request review comment event: 12
  • Pull request review event: 13
  • Pull request event: 3
  • Fork event: 1
Last Year
  • Issue comment event: 1
  • Push event: 6
  • Pull request review comment event: 12
  • Pull request review event: 13
  • Pull request event: 3
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • the-professor510 (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/build.yml actions
  • JamesIves/github-pages-deploy-action 3.7.1 composite
  • actions/checkout v3 composite
  • actions/setup-python v1 composite
  • awvwgk/setup-fortran v1 composite
  • codecov/codecov-action v3.1.1 composite
  • fortran-lang/setup-fpm v5 composite