Skip to content

Commit

Permalink
build based on ec1958f
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 24, 2025
1 parent 3c6b6af commit 5845fc3
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-23T15:36:01","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-24T11:16:17","documenter_version":"1.8.0"}}
4 changes: 2 additions & 2 deletions dev/api/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
medium = CustomMedium()

# Use the medium in calculations
println(CherenkovMediumBase.pressure(medium))</code></pre><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><p>The following sections provide detailed documentation for the package:</p><ul><li><a href="api/#CherenkovMediumBase.DIPPR105Params"><code>CherenkovMediumBase.DIPPR105Params</code></a></li><li><a href="api/#CherenkovMediumBase.HenyeyGreenStein"><code>CherenkovMediumBase.HenyeyGreenStein</code></a></li><li><a href="api/#CherenkovMediumBase.KopelevichScatteringModel"><code>CherenkovMediumBase.KopelevichScatteringModel</code></a></li><li><a href="api/#CherenkovMediumBase.PolynomialScatteringFunction"><code>CherenkovMediumBase.PolynomialScatteringFunction</code></a></li><li><a href="api/#CherenkovMediumBase.QuanFryDispersion-Tuple{Any, Any, Any}"><code>CherenkovMediumBase.QuanFryDispersion</code></a></li><li><a href="api/#CherenkovMediumBase.QuanFryDispersion"><code>CherenkovMediumBase.QuanFryDispersion</code></a></li><li><a href="api/#CherenkovMediumBase.QuanFryDispersion-NTuple{4, Any}"><code>CherenkovMediumBase.QuanFryDispersion</code></a></li><li><a href="api/#CherenkovMediumBase.SimplifiedLiu"><code>CherenkovMediumBase.SimplifiedLiu</code></a></li><li><a href="api/#CherenkovMediumBase.TwoComponentScatteringModel"><code>CherenkovMediumBase.TwoComponentScatteringModel</code></a></li><li><a href="api/#CherenkovMediumBase.DIPPR105"><code>CherenkovMediumBase.DIPPR105</code></a></li><li><a href="api/#CherenkovMediumBase._hg_scattering_func-Union{Tuple{T}, Tuple{Random.AbstractRNG, T}} where T&lt;:Real"><code>CherenkovMediumBase._hg_scattering_func</code></a></li><li><a href="api/#CherenkovMediumBase._refractive_index_fry-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase._refractive_index_fry</code></a></li><li><a href="api/#CherenkovMediumBase._sca_len_part_conc-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase._sca_len_part_conc</code></a></li><li><a href="api/#CherenkovMediumBase.absorption_length-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.absorption_length</code></a></li><li><a href="api/#CherenkovMediumBase.calc_quan_fry_params-Tuple{Real, Real, Real}"><code>CherenkovMediumBase.calc_quan_fry_params</code></a></li><li><a href="api/#CherenkovMediumBase.cherenkov_angle-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.cherenkov_angle</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.dispersion</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion-Tuple{QuanFryDispersion, Any}"><code>CherenkovMediumBase.dispersion</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion-Tuple{CherenkovMediumBase.AbstractDispersionModel}"><code>CherenkovMediumBase.dispersion</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion_fry-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase.dispersion_fry</code></a></li><li><a href="api/#CherenkovMediumBase.es_scattering-Union{Tuple{T}, Tuple{T, T}} where T&lt;:Real"><code>CherenkovMediumBase.es_scattering</code></a></li><li><a href="api/#CherenkovMediumBase.es_scattering_cumulative-Union{Tuple{T}, Tuple{T, T}} where T&lt;:Real"><code>CherenkovMediumBase.es_scattering_cumulative</code></a></li><li><a href="api/#CherenkovMediumBase.es_scattering_integral-Union{Tuple{T}, Tuple{T, T}} where T&lt;:Real"><code>CherenkovMediumBase.es_scattering_integral</code></a></li><li><a href="api/#CherenkovMediumBase.group_refractive_index-Tuple{Any, Any}"><code>CherenkovMediumBase.group_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.group_velocity-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.group_velocity</code></a></li><li><a href="api/#CherenkovMediumBase.make_inverse_es_polynomial-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase.make_inverse_es_polynomial</code></a></li><li><a href="api/#CherenkovMediumBase.material_density-Tuple{MediumProperties}"><code>CherenkovMediumBase.material_density</code></a></li><li><a href="api/#CherenkovMediumBase.phase_refractive_index-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.phase_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.phase_refractive_index-Tuple{QuanFryDispersion, Any}"><code>CherenkovMediumBase.phase_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.phase_refractive_index-Tuple{CherenkovMediumBase.AbstractDispersionModel}"><code>CherenkovMediumBase.phase_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.pressure-Tuple{MediumProperties}"><code>CherenkovMediumBase.pressure</code></a></li><li><a href="api/#CherenkovMediumBase.radiation_length-Tuple{MediumProperties}"><code>CherenkovMediumBase.radiation_length</code></a></li><li><a href="api/#CherenkovMediumBase.sample_scattering_function-Tuple{MediumProperties}"><code>CherenkovMediumBase.sample_scattering_function</code></a></li><li><a href="api/#CherenkovMediumBase.scattering_length-Tuple{KopelevichScatteringModel, Real}"><code>CherenkovMediumBase.scattering_length</code></a></li><li><a href="api/#CherenkovMediumBase.scattering_length-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.scattering_length</code></a></li><li><a href="api/#CherenkovMediumBase.sl_scattering_func-Union{Tuple{T}, Tuple{Random.AbstractRNG, T}} where T&lt;:Real"><code>CherenkovMediumBase.sl_scattering_func</code></a></li><li><a href="api/#CherenkovMediumBase.temperature-Tuple{MediumProperties}"><code>CherenkovMediumBase.temperature</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 23 January 2025 15:36">Thursday 23 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
println(CherenkovMediumBase.pressure(medium))</code></pre><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><p>The following sections provide detailed documentation for the package:</p><ul><li><a href="api/#CherenkovMediumBase.DIPPR105Params"><code>CherenkovMediumBase.DIPPR105Params</code></a></li><li><a href="api/#CherenkovMediumBase.HenyeyGreenStein"><code>CherenkovMediumBase.HenyeyGreenStein</code></a></li><li><a href="api/#CherenkovMediumBase.KopelevichScatteringModel"><code>CherenkovMediumBase.KopelevichScatteringModel</code></a></li><li><a href="api/#CherenkovMediumBase.PolynomialScatteringFunction"><code>CherenkovMediumBase.PolynomialScatteringFunction</code></a></li><li><a href="api/#CherenkovMediumBase.QuanFryDispersion-Tuple{Any, Any, Any}"><code>CherenkovMediumBase.QuanFryDispersion</code></a></li><li><a href="api/#CherenkovMediumBase.QuanFryDispersion"><code>CherenkovMediumBase.QuanFryDispersion</code></a></li><li><a href="api/#CherenkovMediumBase.QuanFryDispersion-NTuple{4, Any}"><code>CherenkovMediumBase.QuanFryDispersion</code></a></li><li><a href="api/#CherenkovMediumBase.SimplifiedLiu"><code>CherenkovMediumBase.SimplifiedLiu</code></a></li><li><a href="api/#CherenkovMediumBase.TwoComponentScatteringFunction"><code>CherenkovMediumBase.TwoComponentScatteringFunction</code></a></li><li><a href="api/#CherenkovMediumBase.DIPPR105"><code>CherenkovMediumBase.DIPPR105</code></a></li><li><a href="api/#CherenkovMediumBase._hg_scattering_func-Union{Tuple{T}, Tuple{Random.AbstractRNG, T}} where T&lt;:Real"><code>CherenkovMediumBase._hg_scattering_func</code></a></li><li><a href="api/#CherenkovMediumBase._refractive_index_fry-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase._refractive_index_fry</code></a></li><li><a href="api/#CherenkovMediumBase._sca_len_part_conc-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase._sca_len_part_conc</code></a></li><li><a href="api/#CherenkovMediumBase.absorption_length-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.absorption_length</code></a></li><li><a href="api/#CherenkovMediumBase.calc_quan_fry_params-Tuple{Real, Real, Real}"><code>CherenkovMediumBase.calc_quan_fry_params</code></a></li><li><a href="api/#CherenkovMediumBase.cherenkov_angle-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.cherenkov_angle</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion-Tuple{CherenkovMediumBase.AbstractDispersionModel}"><code>CherenkovMediumBase.dispersion</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion-Tuple{QuanFryDispersion, Any}"><code>CherenkovMediumBase.dispersion</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.dispersion</code></a></li><li><a href="api/#CherenkovMediumBase.dispersion_fry-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase.dispersion_fry</code></a></li><li><a href="api/#CherenkovMediumBase.es_scattering-Union{Tuple{T}, Tuple{T, T}} where T&lt;:Real"><code>CherenkovMediumBase.es_scattering</code></a></li><li><a href="api/#CherenkovMediumBase.es_scattering_cumulative-Union{Tuple{T}, Tuple{T, T}} where T&lt;:Real"><code>CherenkovMediumBase.es_scattering_cumulative</code></a></li><li><a href="api/#CherenkovMediumBase.es_scattering_integral-Union{Tuple{T}, Tuple{T, T}} where T&lt;:Real"><code>CherenkovMediumBase.es_scattering_integral</code></a></li><li><a href="api/#CherenkovMediumBase.get_dispersion_model-Tuple{MediumProperties}"><code>CherenkovMediumBase.get_dispersion_model</code></a></li><li><a href="api/#CherenkovMediumBase.get_scattering_model-Tuple{MediumProperties}"><code>CherenkovMediumBase.get_scattering_model</code></a></li><li><a href="api/#CherenkovMediumBase.group_refractive_index-Tuple{Any, Any}"><code>CherenkovMediumBase.group_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.group_velocity-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.group_velocity</code></a></li><li><a href="api/#CherenkovMediumBase.make_inverse_es_polynomial-Tuple{T} where T&lt;:Real"><code>CherenkovMediumBase.make_inverse_es_polynomial</code></a></li><li><a href="api/#CherenkovMediumBase.material_density-Tuple{MediumProperties}"><code>CherenkovMediumBase.material_density</code></a></li><li><a href="api/#CherenkovMediumBase.phase_refractive_index-Tuple{CherenkovMediumBase.AbstractDispersionModel}"><code>CherenkovMediumBase.phase_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.phase_refractive_index-Tuple{QuanFryDispersion, Any}"><code>CherenkovMediumBase.phase_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.phase_refractive_index-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.phase_refractive_index</code></a></li><li><a href="api/#CherenkovMediumBase.pressure-Tuple{MediumProperties}"><code>CherenkovMediumBase.pressure</code></a></li><li><a href="api/#CherenkovMediumBase.radiation_length-Tuple{MediumProperties}"><code>CherenkovMediumBase.radiation_length</code></a></li><li><a href="api/#CherenkovMediumBase.sample_scattering_function-Tuple{MediumProperties}"><code>CherenkovMediumBase.sample_scattering_function</code></a></li><li><a href="api/#CherenkovMediumBase.scattering_length-Tuple{KopelevichScatteringModel, Real}"><code>CherenkovMediumBase.scattering_length</code></a></li><li><a href="api/#CherenkovMediumBase.scattering_length-Tuple{MediumProperties, Any}"><code>CherenkovMediumBase.scattering_length</code></a></li><li><a href="api/#CherenkovMediumBase.sl_scattering_func-Union{Tuple{T}, Tuple{Random.AbstractRNG, T}} where T&lt;:Real"><code>CherenkovMediumBase.sl_scattering_func</code></a></li><li><a href="api/#CherenkovMediumBase.temperature-Tuple{MediumProperties}"><code>CherenkovMediumBase.temperature</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 24 January 2025 11:16">Friday 24 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Binary file modified dev/objects.inv
View file
Binary file not shown.
Loading

0 comments on commit 5845fc3

Please sign in to comment.