Merge pull request #97 from Mizu49/release/v0.0.2

Release v0.0.2

Author: Mizu49

.devcontainer/Dockerfile

@@ -14,14 +14,7 @@ RUN apt-get install -y git
 # https://gr-framework.org/julia.html#installation
 RUN apt-get install -y libxt6 libxrender1 libxext6 libgl1-mesa-glx libqt5widgets5
 
-# Install `Plots.jl and precompile it`
-RUN julia -e 'using Pkg; Pkg.REPLMode.pkgstr("add Plots;precompile");using Plots'
+# Required in the build process
+RUN apt-get install unzip
 
-# Install `Reexport.jl`
-RUN julia -e 'import Pkg; Pkg.add("Reexport")'
-
-# Install `Documenter.jl`
-RUN julia -e 'import Pkg; Pkg.add("Documenter")'
-
-# Install `LiveServer.jl` to serve the documentation locally
-RUN julia -e 'import Pkg; Pkg.add("LiveServer")'
+ENV PATH="/root/.julia/bin:$PATH"

.gitignore

@@ -1,5 +1,5 @@
-# Output files generated by our program
-*.gif
+# Output directory
+output*
 
 # Files generated by invoking Julia with --code-coverage
 *.jl.cov
@@ -30,3 +30,9 @@ Manifest.toml
 # Exclude image files
 *png
 *svg
+*.gif
+
+# But not exclude images under `docs/src/`
+!docs/src/**/*.png
+!docs/src/**/*.gif
+

Comonicon.toml

@@ -0,0 +1,5 @@
+name = "evalspacecraft"
+
+[application]
+incremental=true
+filter_stdlibs=false

Project.toml

@@ -1,9 +1,21 @@
 name = "FlexibleSpacecraft"
 uuid = "2c2948cf-05c7-4427-a57b-abbb12bec472"
 authors = ["Mizu49 <mizuki.abe.r4@dc.tohoku.ac.jp>"]
-version = "0.0.0"
+version = "0.0.2"
 
 [deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+Comonicon = "863f3e99-da2a-4334-8734-de3dacbe5542"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
+Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
+StructArrays = "09ab397b-f2b6-538f-b94a-2f83cf4a842a"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"

README.md

@@ -1,13 +1,17 @@
 # FlexibleSpacecraft.jl
 
-`FlexibleSpacecraft.jl` is **an Open Source Spacecraft Attitude-Structure Coupling Simulator** developed in Julia Language.
-
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://mizu49.github.io/FlexibleSpacecraft.jl/stable)
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://mizu49.github.io/FlexibleSpacecraft.jl/dev)
 
+![Flexible spacecraft](docs/src/assets/flexible_spacecraft.png)
+
+`FlexibleSpacecraft.jl` is **an Open Source Spacecraft Attitude-Structure Coupling Simulator and Evaluator** developed in Julia Language, aiming to accelerate the development of the challenging space missions.
+
 Our focus is the coupling problem of structural vibration and spacecraft attitude. The structural and attitude control systems of spacecraft have been treated as separate problems. However, the coupled structure-attitude dynamic analysis will be necessary for the next generation spacecraft with extensive and flexible structures envisioned in the future. A simulator of the structure-attitude coupling system will make it possible to verify the problem efficiently and accelerate the development of the next-generation spacecraft.
 
 *This project is quite new and under active development for open-source release.*
+
+![attitude gif](docs/src/assets/attitude_gif.gif)
 ## Contribution guideline
 
-We really appreciate your contribution! See [Contribution Guideline](https://github.com/Mizu49/FlexibleSpacecraft.jl/blob/main/.github/CONTRIBUTING.md) and [Developer's Guideline](https://mizu49.github.io/FlexibleSpacecraft.jl/stable/development/developer's-guideline/) for more information.
+We appreciate your contribution! See [Contribution Guideline](https://github.com/Mizu49/FlexibleSpacecraft.jl/blob/main/.github/CONTRIBUTING.md) and [Developer's Guideline](https://mizu49.github.io/FlexibleSpacecraft.jl/stable/development/developer's-guideline/) for more information.

deps/build.jl

@@ -0,0 +1,2 @@
+import FlexibleSpacecraft
+FlexibleSpacecraft.comonicon_install()

docs/liveserver.jl renamed to docs/local-preview.jl

@@ -2,7 +2,7 @@
 
 using LiveServer
 
-println("Build and preview documentation locally!!")
+println("Build and preview documentation locally")
 
 # Build documentation
 println("Building the documentation...")

docs/make.jl

@@ -1,16 +1,33 @@
 using Documenter
 
+using FlexibleSpacecraft
+
 # Build documentation
 makedocs(
     sitename="FlexibleSpacecraft.jl",
     pages = [
         "home" => "index.md",
-        "Development" => [
-            "Developer's Guideline" => "development/developer's-guideline.md",
-            "Environment" => "development/environment.md"
+        "Example" => "examples/example.md",
+        "Simulation" => [
+            "Core" => "simulation/simulation_core.md",
+            "Configuration" => "simulation/simulation_config.md"
         ],
+        "CLI" => "docs-CLI/index.md",
         "Dynamics" => [
             "Frames" => "dynamics/frames.md",
+            "Attitude dynamics" => "dynamics/attitude.md",
+            "Rigid body" => "dynamics/rigid-body.md",
+            "Orbit" => "dynamics/orbit.md",
+            "Disturbance input" => "dynamics/disturbance.md"
+        ],
+        "Libraries" => [
+            "API" => "docs-module/docs-SimulationAPI.md",
+            "Data containers" => "docs-module/docs-DataContainers.md",
+            "Plot recipe" => "docs-module/docs-PlotRecipe.md"
+        ],
+        "Development" => [
+            "Developer's Guideline" => "development/developer's-guideline.md",
+            "Environment" => "development/environment.md"
         ]
     ]
 )