Create README.md

Bulnabi-SNU · Feb 9, 2025 · 96d51af · 96d51af
1 parent 7e67aaa
commit 96d51af
Showing 1 changed file with 74 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,74 @@
+<h1 align="center">K-FORCAST <br><br>
+<i>Team Korea - Flight Optimized RC Aircraft Sizing Tool</i></h1> 
+<br>
+
+`K-FORCAST` is a aircraft sizing tool for the RC fixed-wing aircraft developed by  
+**Team Korea** (`Seoul National University`, `Gyeongsang National University`, `Konkuk University`) for the [AIAA DBF 2025 competition](https://www.aiaa.org/dbf).
+<p align="center">
+<img src="https://cdn.discordapp.com/attachments/1253108078488977551/1337800696208298014/Screenshot_from_2025-02-09_00-02-10.png?ex=67a8c37d&is=67a771fd&hm=5127ef6cc3dd8cafc763c59367af041a66cfb41d446ab15a56011a17bda4b910&" alt="DBF Logo" width="300" height="100" hspace="50">  <img src="https://cdn.discordapp.com/attachments/1253108078488977551/1337802641392275587/image.png?ex=67a8c54c&is=67a773cc&hm=ceb281c9456fe2e931933929845599e5ba1a3246a33efd6edf525534e2c96b17&" alt="DBF Logo" width="100" height="100" hspace="50">
+</p>
+
+## ⭐ Usage
+
+It can be effectively used in the following situations.
+- When finding the optimal aircraft design parameters for a predetermined flight path
+- When predicting flight time, remaining battery capacity, and other performance metrics with a fixed aircraft configuration and flight path
+- When obtaining aerodynamic analysis results for a given configuration
+<br></br>
+
+Although the code is structured for the AIAA DBF 2025 mission, it can be easily modified to suit individual objectives. Detailed information on the code structure is provided on the following website.
+
+
+
+## 🔎 About Our Algorithm
+
+Overall algorithm of K-FORCAST is presented below.
+<br>
+<p align="center">
+<img src="https://cdn.discordapp.com/attachments/1253108078488977551/1337805803528126524/image.png?ex=67a8c83e&is=67a776be&hm=cbf793db3f869d69effad896616b22e86dab690b79869e0a5fce86b4cd586419&" alt="Sizing Tool Flowchart" width="650" height="550" >
+</p>
+<br></br>
+
+## 📋 Used API
+
+<p align="center">
+  <img src="https://cdn.discordapp.com/attachments/1253108078488977551/1338012590676246640/title_small.png?ex=67a988d4&is=67a83754&hm=266a49d49f2191d02f59ccee659f59296f89b434b73b3ada425fc6c549ac399b&" alt="OpenVSP Logo" width="400" height="100"> </p>
+<p align="center">  
+  <a href="https://openvsp.org/pyapi_docs/latest/">OpenVSP Python API</a>
+</p>
+<br></br>
+
+## 📝 User Manual 
+
+Supports on `Window + Docker Environment` , `Linux(Ubuntu)` , `Multiple Server Environment` .  
+
+Aerodynamic analysis for a single design configuration takes approximately **15 seconds**, while performance analysis for a single flight configuration takes around **0.68 seconds**. If the grid search range is extensive, it is recommended to run the process in a multiple server environment.
+<br></br>
+
+### ❔ How to use
+
+**Instructions for Window**
+<br>
+**Instructions for Linux**
+<br>
+**Instructions for Server Environment**
+<br></br>
+
+## 👪 Contributors
+
+| Position    | Name        | University                            | Contact                    |
+|-------------|-------------|---------------------------------------|----------------------------|
+| Team Leader | [Jaewoo Lee](https://github.com/jwleesnu) | Seoul National University             | [email protected]     |
+| Developer (Aerodynamic Analysis)   | [Sungjin Kim](https://github.com/SungJinKm)      | Seoul National University        | [email protected]            |
+| Developer (Flight Analysis)  | [Gyeongrak Choi](https://github.com/Gyeong-Rak)      | Seoul National University                     | [email protected]         |
+| Developer (Code Structure)    |  [Jaewon Chung](https://github.com/PresidentPlant)      | Seoul National University             | [email protected]         |
+| Developer (Score Analysis)    |  [Hyeonjung Na](https://github.com/efq3)     | Gyeongsang National University             | [email protected]         |
+| Researcher (Propulsion Analysis)    |  백정흠     | Seoul National University             | [email protected]       |
+| Researcher (Propulsion Analysis)    |  [Sungil Son](https://github.com/One-star11)     | Seoul National University             | [email protected]      |
+| Researcher (Aerodynamic Analysis)    |  Seongwon Jang     | Seoul National University             | [email protected]      |
+| Researcher (Aerodynamic Analysis)    |  권현창     | Seoul National University             | [email protected]      |
+| Researcher (Flight Analysis)    |  [Jeonghwa Heo](https://github.com/JeonghwaHeo)     | Seoul National University             | [email protected]   |
+| Researcher (Flight Analysis)    |  Junyeong Koo     | Seoul National University             | [email protected]    |
+| Researcher (Flight Analysis)    |  하승훈     | Seoul National University             |   [email protected] |
+| Researcher (Flight Analysis)    |  Seojin Kim     | Gyeongsang National University            |   [email protected] |
+| Researcher (Flight Analysis)    |  이준영     | Seoul National University             |   [email protected] |