Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add api.md and physical_model.md #104

Merged
merged 12 commits into from
Dec 10, 2023
Merged

Add api.md and physical_model.md #104

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3048f82
add api.md and physical_model.md
hyrodium Dec 2, 2023
eec1c63
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
c6ad07b
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
f2cde47
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
d3718e8
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
c360a2c
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
2f1aaa1
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
a2593d7
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
511065e
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
aa44ae6
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
9241dad
Update docs/src/physical_model.md
hyrodium Dec 10, 2023
2cbe7e1
Add suggestion by julia-format
hyrodium Dec 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
DocMeta.setdocmeta!(AsteroidThermoPhysicalModels, :DocTestSetup, :(using AsteroidThermoPhysicalModels); recursive=true)

makedocs(;
modules=[AsteroidThermoPhysicalModels],

Check warning on line 7 in docs/make.jl

View workflow job for this annotation

GitHub Actions / code-style 

[JuliaFormatter] reported by reviewdog 🐶


Raw Output:
docs/make.jl:7:-    modules=[AsteroidThermoPhysicalModels],
docs/make.jl:8:-    repo="https://github.com/Astroshaper/AsteroidThermoPhysicalModels.jl/blob/{commit}{path}#{line}",
docs/make.jl:9:-    sitename="AsteroidThermoPhysicalModels.jl",
docs/make.jl:10:-    format=Documenter.HTML(;
docs/make.jl:11:-        prettyurls=get(ENV, "CI", "false") == "true",
docs/make.jl:12:-        canonical="https://Astroshaper.github.io/AsteroidThermoPhysicalModels.jl",
docs/make.jl:13:-        assets=["assets/favicon.ico"],
docs/make.jl:12:+    modules = [AsteroidThermoPhysicalModels],
docs/make.jl:13:+    repo = "https://github.com/Astroshaper/AsteroidThermoPhysicalModels.jl/blob/{commit}{path}#{line}",
docs/make.jl:14:+    sitename = "AsteroidThermoPhysicalModels.jl",
docs/make.jl:15:+    format = Documenter.HTML(;
docs/make.jl:16:+        prettyurls = get(ENV, "CI", "false") == "true",
docs/make.jl:17:+        canonical = "https://Astroshaper.github.io/AsteroidThermoPhysicalModels.jl",
docs/make.jl:18:+        assets = ["assets/favicon.ico"],
repo="https://github.com/Astroshaper/AsteroidThermoPhysicalModels.jl/blob/{commit}{path}#{line}",
sitename="AsteroidThermoPhysicalModels.jl",
format=Documenter.HTML(;
Expand All @@ -14,6 +14,8 @@
),
pages=[
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
"Home" => "index.md",
"Physical model" => "physical_model.md",
"API" => "api.md",
],
)

Expand Down
5 changes: 5 additions & 0 deletions docs/src/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# API

```@autodocs
Modules = [AsteroidThermoPhysicalModels]
```
4 changes: 0 additions & 4 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# AsteroidThermoPhysicalModels.jl

A package for dynamical simulation of an asteroid.

```@autodocs
Modules = [AsteroidThermoPhysicalModels]
```
27 changes: 27 additions & 0 deletions docs/src/physical_model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`` | [kg/m³] | Density |
| ``C_p`` | [J/K] | Heat capacity at constant pressure |
| ``P`` | [s] | Rotation period |
| ``l`` | [m] | Thermal skin depth |
| ``k`` | [W/m/K] | ? |
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
| ``z`` | [m] | Depth |
| ``E`` | [J] | Energy |
hyrodium marked this conversation as resolved.
Show resolved Hide resolved
| ``\Gamma`` | [J ⋅ m⁻² ⋅ K⁻¹ ⋅ s⁻⁰⁵ (tiu)] | Thermal inertia |
| ``\varepsilon`` | [-] | Emissivity |
| ``\Phi`` | [?] | ? |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| ``\Phi`` | [?] | ? |
| ``\Phi`` | [W/m²] | Solar energy flux |

In constants.jl, the same symbol is used as an orbital mean anomaly. This conflict will be resolved in the future.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use $M$ for the value of mean anomaly, like in some Wikipedia articles?

Loading