From 1d7a92dc780073de5ec24f285c19300af570ba9e Mon Sep 17 00:00:00 2001 From: Ujjawal179 Date: Sun, 18 Aug 2024 19:40:51 +0530 Subject: [PATCH 1/6] Add Base Documentation for SU2GUI --- Gemfile | 2 + _config.yml | 22 ++++-- _data/su2gui.yml | 19 +++++ _includes/su2gui_nav.html | 22 ++++++ _includes/su2gui_section_nav.html | 52 ++++++++++++++ _includes/topnav.html | 1 + _layouts/su2gui.html | 55 +++++++++++++++ _su2gui/Build-From-Source.md | 24 +++++++ _su2gui/Configurations.md | 48 +++++++++++++ _su2gui/Initialization.md | 66 ++++++++++++++++++ _su2gui/Installation.md | 26 +++++++ _su2gui/Introduction.md | 35 ++++++++++ _su2gui/Logs-Tab-and-Errors.md | 38 ++++++++++ _su2gui/Manage-Cases.md | 56 +++++++++++++++ _su2gui/Mesh.md | 28 ++++++++ _su2gui/Quick-Start.md | 4 ++ _su2gui/Result-Analysis.md | 43 ++++++++++++ _su2gui/Terminal-Initialization.md | 44 ++++++++++++ .../Configuration/button-config-file.png | Bin 0 -> 581166 bytes .../Configuration/choose-config-file.png | Bin 0 -> 300919 bytes .../User_guide/Configuration/config-tab.png | Bin 0 -> 156479 bytes .../Configuration/loaded-config-file.png | Bin 0 -> 525460 bytes .../User_guide/Logs/error-message.png | Bin 0 -> 243215 bytes su2gui_files/User_guide/Logs/su2-logs.png | Bin 0 -> 134218 bytes su2gui_files/User_guide/Logs/su2gui-logs.png | Bin 0 -> 221883 bytes .../initialization/button-restart-file.png | Bin 0 -> 495276 bytes .../initialization/choose-restart-file.png | Bin 0 -> 284774 bytes .../initialization/initialize-options.png | Bin 0 -> 495222 bytes .../loaded-patch-initialize.png | Bin 0 -> 140094 bytes .../initialization/loaded-restart-file.png | Bin 0 -> 181822 bytes .../loaded-uniform-initialize.png | Bin 0 -> 125706 bytes .../User_guide/mesh/button-mesh-file.png | Bin 0 -> 103645 bytes .../User_guide/mesh/choose-mesh-file.png | Bin 0 -> 153768 bytes .../User_guide/mesh/loaded-mesh-file.png | Bin 0 -> 583066 bytes .../result-analysis/geometry-tab.png | Bin 0 -> 292558 bytes .../result-analysis/history-tab.png | Bin 0 -> 214685 bytes .../monitoring-history-lines.png | Bin 0 -> 191957 bytes su2gui_files/User_guide/start-case.png | Bin 0 -> 22999 bytes su2gui_files/User_guide/workflow.png | Bin 0 -> 188128 bytes 39 files changed, 581 insertions(+), 4 deletions(-) create mode 100644 _data/su2gui.yml create mode 100644 _includes/su2gui_nav.html create mode 100644 _includes/su2gui_section_nav.html create mode 100644 _layouts/su2gui.html create mode 100644 _su2gui/Build-From-Source.md create mode 100644 _su2gui/Configurations.md create mode 100644 _su2gui/Initialization.md create mode 100644 _su2gui/Installation.md create mode 100644 _su2gui/Introduction.md create mode 100644 _su2gui/Logs-Tab-and-Errors.md create mode 100644 _su2gui/Manage-Cases.md create mode 100644 _su2gui/Mesh.md create mode 100644 _su2gui/Quick-Start.md create mode 100644 _su2gui/Result-Analysis.md create mode 100644 _su2gui/Terminal-Initialization.md create mode 100644 su2gui_files/User_guide/Configuration/button-config-file.png create mode 100644 su2gui_files/User_guide/Configuration/choose-config-file.png create mode 100644 su2gui_files/User_guide/Configuration/config-tab.png create mode 100644 su2gui_files/User_guide/Configuration/loaded-config-file.png create mode 100644 su2gui_files/User_guide/Logs/error-message.png create mode 100644 su2gui_files/User_guide/Logs/su2-logs.png create mode 100644 su2gui_files/User_guide/Logs/su2gui-logs.png create mode 100644 su2gui_files/User_guide/initialization/button-restart-file.png create mode 100644 su2gui_files/User_guide/initialization/choose-restart-file.png create mode 100644 su2gui_files/User_guide/initialization/initialize-options.png create mode 100644 su2gui_files/User_guide/initialization/loaded-patch-initialize.png create mode 100644 su2gui_files/User_guide/initialization/loaded-restart-file.png create mode 100644 su2gui_files/User_guide/initialization/loaded-uniform-initialize.png create mode 100644 su2gui_files/User_guide/mesh/button-mesh-file.png create mode 100644 su2gui_files/User_guide/mesh/choose-mesh-file.png create mode 100644 su2gui_files/User_guide/mesh/loaded-mesh-file.png create mode 100644 su2gui_files/User_guide/result-analysis/geometry-tab.png create mode 100644 su2gui_files/User_guide/result-analysis/history-tab.png create mode 100644 su2gui_files/User_guide/result-analysis/monitoring-history-lines.png create mode 100644 su2gui_files/User_guide/start-case.png create mode 100644 su2gui_files/User_guide/workflow.png diff --git a/Gemfile b/Gemfile index 9b5e72ad..6f29a58f 100644 --- a/Gemfile +++ b/Gemfile @@ -1,6 +1,8 @@ source 'https://rubygems.org' group :jekyll_plugins do + gem 'tzinfo' gem 'github-pages' gem 'jekyll-twitter-plugin' gem 'webrick' + gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby] end diff --git a/_config.yml b/_config.yml index f09ad726..c4a56f4b 100644 --- a/_config.yml +++ b/_config.yml @@ -16,11 +16,12 @@ bootwatch: yeti # Build settings markdown: kramdown highlighter: rouge -gems: +plugins: - jekyll-feed - jekyll-redirect-from - jekyll-seo-tag - jekyll-sitemap + - jekyll-gist whitelist: - jekyll-redirect-from @@ -32,7 +33,9 @@ exclude: - .idea/ - .gitignore - README.md -timezone: Europe/Berlin + +timezone: "America/New_York" + defaults: - scope: path: _posts @@ -76,6 +79,16 @@ defaults: sectionid: vandv seo: type: "WebPage" + +- scope: + path: _su2gui + type: su2gui + values: + layout: su2gui + sectionid: su2gui + seo: + type: "WebPage" + collections: docs: permalink: /:collection/:path/ @@ -89,6 +102,9 @@ collections: vandv: permalink: /:collection/:path/ output: true + su2gui: + permalink: /:collection/:path/ + output: true posts: permalink: /blog/:year/:month/:day/:title/ output: true @@ -96,5 +112,3 @@ collections: # Google Analytics google_analytics: UA-28187985-1 -plugins: - - jekyll-gist diff --git a/_data/su2gui.yml b/_data/su2gui.yml new file mode 100644 index 00000000..3eb56ca2 --- /dev/null +++ b/_data/su2gui.yml @@ -0,0 +1,19 @@ +- title: Introduction to SU2GUI + su2gui: + - Introduction + - Quick-Start + +- title: Installation + su2gui: + - Installation + - Build-From-Source + +- title: User Guide + su2gui: + - Terminal-Initialization + - Manage-Cases + - Mesh-File + - configurations + - Initialization + - Logs-Errors + - Result-Analysis \ No newline at end of file diff --git a/_includes/su2gui_nav.html b/_includes/su2gui_nav.html new file mode 100644 index 00000000..f2d70c56 --- /dev/null +++ b/_includes/su2gui_nav.html @@ -0,0 +1,22 @@ +
+{% for section in site.data.su2gui %} +
+
+

+ +

+
+
+
    + {% for item in section.su2gui %} + {% assign item_url = item | prepend:"/su2gui/" | append:"/" %} + {% assign p = site.su2gui | where:"url", item_url | first %} + {{ p.title }} + {% endfor %} +
+
+
+{% endfor %} +
diff --git a/_includes/su2gui_section_nav.html b/_includes/su2gui_section_nav.html new file mode 100644 index 00000000..a57f63f6 --- /dev/null +++ b/_includes/su2gui_section_nav.html @@ -0,0 +1,52 @@ +{% comment %} +Map grabs the doc sections, giving us an array of arrays. Join, flattens all +the items to a comma delimited string. Split turns it into an array again. +{% endcomment %} +{% assign su2gui = site.data.su2gui | map: 'su2gui' | join: ',' | split: ',' %} + +{% comment %} +Because this is built for every page, lets find where we are in the ordered +document list by comparing url strings. Then if there's something previous or +next, lets build a link to it. +{% endcomment %} + +{% for document in su2gui %} + {% assign document_url = document | prepend:"/su2gui/" | append:"/" %} + {% if document_url == page.url %} +