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.

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

merged 12 commits into from
Dec 10, 2023

Conversation

hyrodium
Copy link
Member

@hyrodium hyrodium commented Dec 2, 2023

No description provided.

Copy link

codecov bot commented Dec 2, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b7cd460) 93.84% compared to head (2cbe7e1) 93.90%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #104      +/-   ##
==========================================
+ Coverage   93.84%   93.90%   +0.05%     
==========================================
  Files          10       10              
  Lines         650      656       +6     
==========================================
+ Hits          610      616       +6     
  Misses         40       40              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@MasanoriKanamaru MasanoriKanamaru left a comment

Choose a reason for hiding this comment

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

I added some explanations of the symbols.

docs/src/physical_model.md Outdated Show resolved Hide resolved
docs/src/physical_model.md Outdated Show resolved Hide resolved
docs/src/physical_model.md Outdated Show resolved Hide resolved
docs/src/physical_model.md Outdated Show resolved Hide resolved
| ``E`` | [J] | Energy |
| ``\Gamma`` | [?] | ? |
| ``\varepsilon`` | [?] | ? |
| ``\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?

docs/make.jl Outdated Show resolved Hide resolved
hyrodium and others added 4 commits December 10, 2023 17:28
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
@hyrodium hyrodium merged commit 5e11263 into main Dec 10, 2023
12 of 13 checks passed
@hyrodium hyrodium deleted the feature/more_docs branch September 7, 2024 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants