Monte Carlo in Single Layer Biological Tissue
git clone anongit@rnpnr.xyz:oblique_mc.git
Log | Files | Refs | Feed | README | LICENSE

Commit: 0797f2e431423813d37609e9c5b8c3101206a129
Parent: c20f629f18ae50d1e53bea9d3153ee594703f485
Author: Randy Palamar
Date:   Thu,  4 Apr 2024 06:39:20 -0600


A.gitignore | 4++++
ALICENSE | 24++++++++++++++++++++++++
AREADME.md | 41+++++++++++++++++++++++++++++++++++++++++
Aexample.png | 0
4 files changed, 69 insertions(+), 0 deletions(-)

diff --git a/.gitignore b/.gitignore @@ -0,0 +1,4 @@ +config.h +mc +*.csv +*.tsv diff --git a/LICENSE b/LICENSE @@ -0,0 +1,24 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to <https://unlicense.org> diff --git a/README.md b/README.md @@ -0,0 +1,41 @@ +# Oblique Incidence Monte Carlo + +This code simulates an obliquely incident photon source (pencil +beam) on a scattering medium. It can simulate one incident point +source or many. + +![Diffuse Reflectance](example.png) + +## Configuration + +Configuration is changed by copying `config.def.h` to `config.h` +and editing it. This configuration is then baked into the compiled +binary. This helps the compiler optimize for the binary for a +faster runtime and keeps the types of configuration variables +clear. + +## Building + +After copying over and editing `config.h` the program can be +compiled by running: + +``` +./build.sh +``` + +## Running + +The compiled program can be run as: + +``` +./mc output_filename_prefix +``` + +Currently directories in `output_filename_prefix` are not checked +for existence prior to running so the program will fail to save +the output if you don't ensure this yourself. + +## Citations + +If you intend on using this as a basis for any published works a +citation, while not required, would be appreciated 🙂! diff --git a/example.png b/example.png Binary files differ.