Skip to content

Commit 00c4d97

Browse files
author
Documenter.jl
committed
build based on f8c588d
1 parent 462ad75 commit 00c4d97

9 files changed

Lines changed: 26 additions & 38 deletions

File tree

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-06-10T03:09:08","julia_version":"1.12.6"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-06-10T07:01:33","julia_version":"1.12.6"}}

dev/api/index.html

Lines changed: 19 additions & 31 deletions
Large diffs are not rendered by default.

dev/benchmarks/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
ephem = # ... your ephemerides
1313

1414
# Benchmark
15-
@benchmark run_TPM!($stpm, $ephem, Float64[], Int[]; show_progress=false)</code></pre><p>For detailed benchmarking, see the <code>benchmark/</code> directory in the source repository.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Usage Examples</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 03:09">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
15+
@benchmark run_TPM!($stpm, $ephem, Float64[], Int[]; show_progress=false)</code></pre><p>For detailed benchmarking, see the <code>benchmark/</code> directory in the source repository.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Usage Examples</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 07:01">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,4 +261,4 @@
261261

262262
# New unified API (recommended)
263263
# All coordinate transformations are handled internally
264-
AsteroidThermoPhysicalModels.update_flux_all!(btpm, r☉₁, r₁₂, R₁₂)</code></pre><p>The unified API automatically handles all flux calculations and coordinate transformations, making the code cleaner and more efficient.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../physical_model/">« Physical model</a><a class="docs-footer-nextpage" href="../benchmarks/">Performance »</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 03:09">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
264+
AsteroidThermoPhysicalModels.update_flux_all!(btpm, r☉₁, r₁₂, R₁₂)</code></pre><p>The unified API automatically handles all flux calculations and coordinate transformations, making the code cleaner and more efficient.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../physical_model/">« Physical model</a><a class="docs-footer-nextpage" href="../benchmarks/">Performance »</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 07:01">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@
5959
)
6060

6161
# Run TPM for binary system
62-
result = run_TPM!(btpm, binary_ephem, times_to_save, face_ID_pri, face_ID_sec)</code></pre><h2 id="Non-Gravitational-Effects"><a class="docs-heading-anchor" href="#Non-Gravitational-Effects">Non-Gravitational Effects</a><a id="Non-Gravitational-Effects-1"></a><a class="docs-heading-anchor-permalink" href="#Non-Gravitational-Effects" title="Permalink"></a></h2><h3 id="Yarkovsky-Effect"><a class="docs-heading-anchor" href="#Yarkovsky-Effect">Yarkovsky Effect</a><a id="Yarkovsky-Effect-1"></a><a class="docs-heading-anchor-permalink" href="#Yarkovsky-Effect" title="Permalink"></a></h3><p>The Yarkovsky effect is an orbital perturbation caused by the asymmetric thermal radiation resulting from thermal inertia. This effect primarily affects the semi-major axis of the asteroid&#39;s orbit. The thermal force calculated by the TPM can be used to determine the magnitude and direction of the Yarkovsky effect on the asteroid&#39;s orbit. You should note that the output force is calculated in the asteroid-fixed frame, so you need to transform it to the inertial frame.</p><h3 id="YORP-Effect"><a class="docs-heading-anchor" href="#YORP-Effect">YORP Effect</a><a id="YORP-Effect-1"></a><a class="docs-heading-anchor-permalink" href="#YORP-Effect" title="Permalink"></a></h3><p>The YORP effect (Yarkovsky–O&#39;Keefe–Radzievskii–Paddack effect) is a rotational perturbation resulting from thermal radiation due to the asymmetric shape of the asteroid. This effect influences the rotation rate and the orientation of the asteroid&#39;s spin axis. The thermal torque calculated by the TPM can be used to determine the magnitude and direction of the YORP effect on the asteroid&#39;s rotation. You should note that the output torque is calculated in the asteroid-fixed frame, so you need to transform it to the inertial frame.</p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>For more details on the package development and the thermophysical model, refer to the following references:</p><ul><li><a href="https://doi.org/10.57350/jesa.206">Kanamaru et al. (2024)</a> - Thermophysical Model Development for Hera Mission to Simulate Non-Gravitational Acceleration on Binary Asteroid</li><li><a href="https://www.wakusei.jp/book/pp/2024/2024-3/235-242_p.pdf">金丸ほか (2024)</a> - 二重小惑星探査計画Heraに向けた小惑星熱物理モデルの開発 (in Japanese)</li></ul><p>The package contributes the following publications:</p><ul><li><a href="https://doi.org/10.1029/2021JE006863">Kanamaru et al. (2021)</a> - YORP Effect on Asteroid 162173 Ryugu: Implications for the Dynamical History</li><li><a href="https://iopscience.iop.org/article/10.3847/2041-8213/ad4f7f">Zhou et al. (2024)</a> - The Yarkovsky Effect on the Long-term Evolution of Binary Asteroids</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="physical_model/">Physical model »</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 03:09">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
62+
result = run_TPM!(btpm, binary_ephem, times_to_save, face_ID_pri, face_ID_sec)</code></pre><h2 id="Non-Gravitational-Effects"><a class="docs-heading-anchor" href="#Non-Gravitational-Effects">Non-Gravitational Effects</a><a id="Non-Gravitational-Effects-1"></a><a class="docs-heading-anchor-permalink" href="#Non-Gravitational-Effects" title="Permalink"></a></h2><h3 id="Yarkovsky-Effect"><a class="docs-heading-anchor" href="#Yarkovsky-Effect">Yarkovsky Effect</a><a id="Yarkovsky-Effect-1"></a><a class="docs-heading-anchor-permalink" href="#Yarkovsky-Effect" title="Permalink"></a></h3><p>The Yarkovsky effect is an orbital perturbation caused by the asymmetric thermal radiation resulting from thermal inertia. This effect primarily affects the semi-major axis of the asteroid&#39;s orbit. The thermal force calculated by the TPM can be used to determine the magnitude and direction of the Yarkovsky effect on the asteroid&#39;s orbit. You should note that the output force is calculated in the asteroid-fixed frame, so you need to transform it to the inertial frame.</p><h3 id="YORP-Effect"><a class="docs-heading-anchor" href="#YORP-Effect">YORP Effect</a><a id="YORP-Effect-1"></a><a class="docs-heading-anchor-permalink" href="#YORP-Effect" title="Permalink"></a></h3><p>The YORP effect (Yarkovsky–O&#39;Keefe–Radzievskii–Paddack effect) is a rotational perturbation resulting from thermal radiation due to the asymmetric shape of the asteroid. This effect influences the rotation rate and the orientation of the asteroid&#39;s spin axis. The thermal torque calculated by the TPM can be used to determine the magnitude and direction of the YORP effect on the asteroid&#39;s rotation. You should note that the output torque is calculated in the asteroid-fixed frame, so you need to transform it to the inertial frame.</p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>For more details on the package development and the thermophysical model, refer to the following references:</p><ul><li><a href="https://doi.org/10.57350/jesa.206">Kanamaru et al. (2024)</a> - Thermophysical Model Development for Hera Mission to Simulate Non-Gravitational Acceleration on Binary Asteroid</li><li><a href="https://www.wakusei.jp/book/pp/2024/2024-3/235-242_p.pdf">金丸ほか (2024)</a> - 二重小惑星探査計画Heraに向けた小惑星熱物理モデルの開発 (in Japanese)</li></ul><p>The package contributes the following publications:</p><ul><li><a href="https://doi.org/10.1029/2021JE006863">Kanamaru et al. (2021)</a> - YORP Effect on Asteroid 162173 Ryugu: Implications for the Dynamical History</li><li><a href="https://iopscience.iop.org/article/10.3847/2041-8213/ad4f7f">Zhou et al. (2024)</a> - The Yarkovsky Effect on the Long-term Evolution of Binary Asteroids</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="physical_model/">Physical model »</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 07:01">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/migration/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
mutual_heating!(btpm, r₁₂, R₂₁)
1616

1717
# New (v0.1.0) — unified single call
18-
update_flux_all!(btpm, r☉₁, r₁₂, R₁₂)</code></pre><h3 id="4.-Minimum-Julia-version"><a class="docs-heading-anchor" href="#4.-Minimum-Julia-version">4. Minimum Julia version</a><a id="4.-Minimum-Julia-version-1"></a><a class="docs-heading-anchor-permalink" href="#4.-Minimum-Julia-version" title="Permalink"></a></h3><p>Raised from 1.6 to 1.10.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API Reference</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 03:09">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
18+
update_flux_all!(btpm, r☉₁, r₁₂, R₁₂)</code></pre><h3 id="4.-Minimum-Julia-version"><a class="docs-heading-anchor" href="#4.-Minimum-Julia-version">4. Minimum Julia version</a><a id="4.-Minimum-Julia-version-1"></a><a class="docs-heading-anchor-permalink" href="#4.-Minimum-Julia-version" title="Permalink"></a></h3><p>Raised from 1.6 to 1.10.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API Reference</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.17.0 on <span class="colophon-date" title="Wednesday 10 June 2026 07:01">Wednesday 10 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/objects.inv

13 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)