From 3048f825f52a218e5d2bc99f1e39956b8d81ad56 Mon Sep 17 00:00:00 2001 From: hyrodium Date: Sat, 2 Dec 2023 16:18:25 +0900 Subject: [PATCH 01/12] add api.md and physical_model.md --- docs/make.jl | 2 ++ docs/src/api.md | 5 +++++ docs/src/index.md | 4 ---- docs/src/physical_model.md | 27 +++++++++++++++++++++++++++ 4 files changed, 34 insertions(+), 4 deletions(-) create mode 100644 docs/src/api.md create mode 100644 docs/src/physical_model.md diff --git a/docs/make.jl b/docs/make.jl index 74e17277..ca789cc8 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -14,6 +14,8 @@ makedocs(; ), pages=[ "Home" => "index.md", + "Physical model" => "physical_model.md", + "API" => "api.md", ], ) diff --git a/docs/src/api.md b/docs/src/api.md new file mode 100644 index 00000000..541a6330 --- /dev/null +++ b/docs/src/api.md @@ -0,0 +1,5 @@ +# API + +```@autodocs +Modules = [AsteroidThermoPhysicalModels] +``` diff --git a/docs/src/index.md b/docs/src/index.md index efb29f30..57a8076a 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,7 +1,3 @@ # AsteroidThermoPhysicalModels.jl A package for dynamical simulation of an asteroid. - -```@autodocs -Modules = [AsteroidThermoPhysicalModels] -``` diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md new file mode 100644 index 00000000..dcb17e6c --- /dev/null +++ b/docs/src/physical_model.md @@ -0,0 +1,27 @@ +# Physical model + +## Overview + + + +## Symbols + +| Symbol | Unit | Description | +| :----- | :--- | :---------- | +| ``t`` | [s] | time | +| ``T`` | [K] | Termperture | +| ``A_B`` | [-] | Bond albedo | +| ``A_\text{TH}`` | [-] | Albedo at thermal infrared wavelength | +| ``F_\text{sun}`` | [W/m²] | Flux of direct sunlight | +| ``F_\text{scat}`` | [W/m²] | Flux of scattered light | +| ``F_\text{rad}`` | [W/m²] | Flux of thermal radiation from surrounding surface | +| ``\rho`` | [?] | ? | +| ``C_p`` | [?] | ? | +| ``P`` | [?] | ? | +| ``l`` | [?] | ? | +| ``k`` | [W/m/K] | ? | +| ``z`` | [m] | depth | +| ``E`` | [J] | Energy | +| ``\Gamma`` | [?] | ? | +| ``\varepsilon`` | [?] | ? | +| ``\Phi`` | [?] | ? | From eec1c63b50a6fda5d877f0588c12d0034df29100 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:24:05 +0900 Subject: [PATCH 02/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index dcb17e6c..9cb51dbc 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -15,7 +15,7 @@ | ``F_\text{sun}`` | [W/m²] | Flux of direct sunlight | | ``F_\text{scat}`` | [W/m²] | Flux of scattered light | | ``F_\text{rad}`` | [W/m²] | Flux of thermal radiation from surrounding surface | -| ``\rho`` | [?] | ? | +| ``\rho`` | [kg/m³] | Density | | ``C_p`` | [?] | ? | | ``P`` | [?] | ? | | ``l`` | [?] | ? | From c6ad07b622967ab0395282023d38447adc2b19dd Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:24:17 +0900 Subject: [PATCH 03/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index 9cb51dbc..75aff0a2 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -16,7 +16,7 @@ | ``F_\text{scat}`` | [W/m²] | Flux of scattered light | | ``F_\text{rad}`` | [W/m²] | Flux of thermal radiation from surrounding surface | | ``\rho`` | [kg/m³] | Density | -| ``C_p`` | [?] | ? | +| ``C_p`` | [J/K] | Heat capacity at constant pressure | | ``P`` | [?] | ? | | ``l`` | [?] | ? | | ``k`` | [W/m/K] | ? | From f2cde47118a6f5dedca0127e780ae7f4963451be Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:24:23 +0900 Subject: [PATCH 04/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index 75aff0a2..568f9683 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -17,7 +17,7 @@ | ``F_\text{rad}`` | [W/m²] | Flux of thermal radiation from surrounding surface | | ``\rho`` | [kg/m³] | Density | | ``C_p`` | [J/K] | Heat capacity at constant pressure | -| ``P`` | [?] | ? | +| ``P`` | [s] | Rotation period | | ``l`` | [?] | ? | | ``k`` | [W/m/K] | ? | | ``z`` | [m] | depth | From d3718e86e84378090d26e73a874f3ff066c8b712 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:24:31 +0900 Subject: [PATCH 05/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index 568f9683..cdcb7627 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -20,7 +20,7 @@ | ``P`` | [s] | Rotation period | | ``l`` | [?] | ? | | ``k`` | [W/m/K] | ? | -| ``z`` | [m] | depth | +| ``z`` | [m] | Depth | | ``E`` | [J] | Energy | | ``\Gamma`` | [?] | ? | | ``\varepsilon`` | [?] | ? | From c360a2c15e6d707256a6a20a40c8f6d14d684001 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:24:42 +0900 Subject: [PATCH 06/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index cdcb7627..3ef305cf 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -18,7 +18,7 @@ | ``\rho`` | [kg/m³] | Density | | ``C_p`` | [J/K] | Heat capacity at constant pressure | | ``P`` | [s] | Rotation period | -| ``l`` | [?] | ? | +| ``l`` | [m] | Thermal skin depth | | ``k`` | [W/m/K] | ? | | ``z`` | [m] | Depth | | ``E`` | [J] | Energy | From 2f1aaa1799fe089529a8b85ce22885062b3f93f9 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:24:48 +0900 Subject: [PATCH 07/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index 3ef305cf..2de4b619 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -22,6 +22,6 @@ | ``k`` | [W/m/K] | ? | | ``z`` | [m] | Depth | | ``E`` | [J] | Energy | -| ``\Gamma`` | [?] | ? | +| ``\Gamma`` | [J ⋅ m⁻² ⋅ K⁻¹ ⋅ s⁻⁰⁵ (tiu)] | Thermal inertia | | ``\varepsilon`` | [?] | ? | | ``\Phi`` | [?] | ? | From a2593d799ae16b187fe7a8c825e0aa0c35cff368 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:24:53 +0900 Subject: [PATCH 08/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index 2de4b619..839f3639 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -23,5 +23,5 @@ | ``z`` | [m] | Depth | | ``E`` | [J] | Energy | | ``\Gamma`` | [J ⋅ m⁻² ⋅ K⁻¹ ⋅ s⁻⁰⁵ (tiu)] | Thermal inertia | -| ``\varepsilon`` | [?] | ? | +| ``\varepsilon`` | [-] | Emissivity | | ``\Phi`` | [?] | ? | From 511065ecfc9d83fc887fba6e51165348bde88d88 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:28:12 +0900 Subject: [PATCH 09/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index 839f3639..9aa496ba 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -24,4 +24,4 @@ | ``E`` | [J] | Energy | | ``\Gamma`` | [J ⋅ m⁻² ⋅ K⁻¹ ⋅ s⁻⁰⁵ (tiu)] | Thermal inertia | | ``\varepsilon`` | [-] | Emissivity | -| ``\Phi`` | [?] | ? | +| ``\Phi`` | [W/m²] | Solar energy flux | From aa44ae6cd7f19aacd29a8471febe7b7d9d2f514b Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:28:30 +0900 Subject: [PATCH 10/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index 9aa496ba..e08fa536 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -21,7 +21,7 @@ | ``l`` | [m] | Thermal skin depth | | ``k`` | [W/m/K] | ? | | ``z`` | [m] | Depth | -| ``E`` | [J] | Energy | +| ``E`` | [J] | Emittance energy | | ``\Gamma`` | [J ⋅ m⁻² ⋅ K⁻¹ ⋅ s⁻⁰⁵ (tiu)] | Thermal inertia | | ``\varepsilon`` | [-] | Emissivity | | ``\Phi`` | [W/m²] | Solar energy flux | From 9241dade24711ece4bb9999076cff2d903460f32 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:28:37 +0900 Subject: [PATCH 11/12] Update docs/src/physical_model.md Co-authored-by: M. Kanamaru --- docs/src/physical_model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/physical_model.md b/docs/src/physical_model.md index e08fa536..a5d81dd4 100644 --- a/docs/src/physical_model.md +++ b/docs/src/physical_model.md @@ -19,7 +19,7 @@ | ``C_p`` | [J/K] | Heat capacity at constant pressure | | ``P`` | [s] | Rotation period | | ``l`` | [m] | Thermal skin depth | -| ``k`` | [W/m/K] | ? | +| ``k`` | [W/m/K] | Thermal conductivity | | ``z`` | [m] | Depth | | ``E`` | [J] | Emittance energy | | ``\Gamma`` | [J ⋅ m⁻² ⋅ K⁻¹ ⋅ s⁻⁰⁵ (tiu)] | Thermal inertia | From 2cbe7e1b887643f5c84ec19f666056b526dbe5a5 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Sun, 10 Dec 2023 17:29:10 +0900 Subject: [PATCH 12/12] Add suggestion by julia-format Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/make.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index ca789cc8..9734761d 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -12,7 +12,7 @@ makedocs(; canonical="https://Astroshaper.github.io/AsteroidThermoPhysicalModels.jl", assets=["assets/favicon.ico"], ), - pages=[ + pages = [ "Home" => "index.md", "Physical model" => "physical_model.md", "API" => "api.md",