ut-issl / s2e-documents Goto Github PK

Overview

Add How to build with Linux.

We need tutorial document for Linux users.

Conditions for close

• When the tutorial is added.

Supplement

NA

Note

NA

Overview

Add tutorial for orbit descending analysis

Details

Orbit descending analysis due to the air drag is important for LEO orbit to estimate the lifetime of the mission.

Conditions for close

• Tutorial is made

Supplement

NA

Note

NA

Overview

Fix typo of bush

Details

There are several typos written as bush. bash　is the correct description.

Conditions for close

When all bush is fixed.

Supplement

NA

Note

• Write a conclusion when closing the issue.

Overview

Add a description of Plot

Details

Write in detail.

Conditions for close

• Write an overview of the Plot feature of S2E
• Add plotted figures into the existing tutorials or specification documents

Supplement

NA

Note

NA

Overview

• Can not build S2E on Ubuntu Docker. It seems Docker for Ubuntu doesn't run properly.

Details

Description

• I couldn't build in Section 3.5 in the HowToCompileWithUbuntuInDocker.md, because of couldn't find s2e-core directory in work directory.
• In stead of s2e-core, I found an empty directory, s2e_core_oss in the work directory in docker container.

Conditions of occurrence

• The environment in which the bug occurs, the condition, parameters, etc.

  • Ubuntu 18.04
  • s2e-documents : main branch c091abd
  • s2e-core : develop branch 95c9b7c

• I confirmed it is reproducible.

Problem

• The document, HowToCompileWithUbuntuInDocker.md expects to use s2e-core directory in section 3.1, but the script to make a docker container uses s2e_core_oss instead of s2e-core. It should be s2e-core.
  It is in the run_core function in setup_docker.sh in s2e-core.

Additional information

• HowToCompileWithUbuntuInDocker.md
• setup_docker.sh

Task

• Fix setup_docker.sh

 function run_core {
-    docker run -it -d --cap-add=SYS_PTRACE --security-opt="seccomp=unconfined" -v /$(realpath ../../../s2e_core_oss):/home/s2e/work/s2e_core_oss --name issl-1 -p 2222:22 issl:latest
+    docker run -it -d --cap-add=SYS_PTRACE --security-opt="seccomp=unconfined" -v /$(realpath ../../../s2e-core):/home/s2e/work/s2e-core --name issl-1 -p 2222:22 issl:latest
 }

Scope of influence

• When you use S2E on Ubuntu Docker environment, you can't build S2E in the Docker.

Supplement

• I confirmed it works well to use above revision of "diff" in "Task"

Overview

Write document for Kepler and Encke method.

Details

ut-issl/s2e-core#79

Conditions for close

• Write documents

Supplement

NA

Note

NA

Overview

Revise some parts of the tutorial

Details

Some parts of the tutorial need to be revised especially for beginners

Conditions for close

When revisions are complete

Supplement

I made an explanation file below to suggest a revision
tutorial_struggling.txt

Note

NA

Overview

Modify links in all documents for GitHub Pages.

Details

To see the documents in the Github Pages, all links should be modified to refer to the Github Pages.

Conditions for close

All links are modified.

Supplement

NA

Note

• GitLabではMarkdown中でMathJaxが使えていた
  • GitHubでは使えない

Overview

Modify equations to suit the MathJax.

Details

We need to modify equations to suit the MathJax style to display equations on the GitHub Pages correctly.

Conditions for close

All equations are correctly displayed.

Supplement

MathJax

Note

NA

Details

Description

The tutorial, "Getting Started: 4. Edit Simulation Conditions" (https://www.space.t.u-tokyo.ac.jp/s2e-documents/Tutorials/GettingStarted.html) asks the user to modify the sample_satellite.ini file to initialize the satellite to a non-zero rotation rate and then to verify that the output log shows the same non-zero rotation rate. However, this tutorial does not mention that this only works if the initialize_mode variable is changed from CONTROLLED to MANUAL.

Conditions of occurrence

Built on Windows10, x86 using VS installation instructions

Additional information

This logs.zip file contains two identical logs where both have defined the initial angular velocity as:

// Initial angular velocity at body frame [rad/s]
initial_angular_velocity_b_rad_s(0) = 0.1234
initial_angular_velocity_b_rad_s(1) = 0.0
initial_angular_velocity_b_rad_s(2) = 0.0

But the first has defined initialize_mode = MANUAL, and the second has defined initialize_mode = CONTROLLED. Observe the difference between the two angular velocity observer graphs below:

Tasks

• Add instruction to change initialize_mode from CONTROLLED to MANUAL for tutorial "Getting Started: 4. Edit Simulation Conditions"

Impact

A tutorial does not work as intended

Priority

very low

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update actions/checkout action to v4.1.7

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Overview

Add tutorial for deep space orbit analysis

Details

S2E can use for deep space orbit analysis. It is important to add a tutorial to explain it.

Conditions for close

• Tutorial is made.

Supplement

NA

Note

NA

Overview

Add tutorial for ground station visibility analysis

Details

Ground station visibility analysis is also important.

Conditions for close

• Tutorial is made

Supplement

NA

Note

NA

Overview

Old descriptions in How to compile with Ubuntu in Docker.

Details

VScodeのアップデートなどにより、上記マニュアルの記述などが古い部分があるとのことなので、修正する。下記が参考になるとのこと

https://ichiri.biz/tech/vscode-remote-explorer-not-showing-ssh-target/

Conditions for close

修正したら

Supplement

NA

Note

NA

Overview

s2e-document should be updated suit with the s2e-core's v8.0.0 major update

Details

TBW

Conditions for close

NA

Supplement

NA

Note

NA

Overview

Update for S2E-CORE v5.0.0 release

Details

S2E-COREのv5.0.0リリースに合わせて、documentを修正する。
特に、ここからdocumentとS2E-COREのバージョン対応がきれいに取れるように管理したい。
例えば、documentとS2E-COREのバージョンを一致させて管理するなど。

Conditions for close

S2E-COREのv5.0.0リリースに合わせて、documentを修正したら。

Supplement

NA

Note

NA