gmshairfoil2d 0.2.31__tar.gz

gmshairfoil2d-0.2.31/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gmshairfoil2d-0.2.31/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: gmshairfoil2d
+Version: 0.2.31
+Summary: Python tool to generate 2D mesh around an airfoil
+Home-page: https://github.com/cfsengineering/GMSH-Airfoil-2D
+Author: Giacomo Benedetti
+Author-email: giacomo.benedetti@cfse.ch
+Keywords: airfoil,2D,mesh,cfd,gmsh
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.11.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gmsh>=4.14
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: pytest>=8.3.4
+Requires-Dist: requests>=2.26.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+[![Pytest](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml)
+[![PyPi version](https://img.shields.io/pypi/v/gmshairfoil2d.svg)](https://pypi.python.org/pypi/gmshairfoil2d)
+[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://github.com/cfsengineering/GMSH-Airfoil-2D/blob/main/LICENSE)
+[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+# GMSH-Airfoil-2D
+
+Python tool to genreate 2D unstructured, hybrid and structured mesh around an airfoil with [GMSH](https://gmsh.info/) in one command line.
+
+## Installation
+
+You can install this package from PyPi:
+
+```bash
+pip install gmshairfoil2d
+```
+
+Or you can clone and install this repository with the following commands:
+
+```bash
+git clone https://github.com/cfsengineering/GMSH-Airfoil-2D.git
+cd GMSH-Airfoil-2D
+pip install -e .
+```
+
+## Usage
+
+```text
+gmshairfoil2d -h                                    
+
+optional arguments:
+  -h, --help                  Show this help message and exit
+  --config [PATH]             Path to configuration file (key=value format)
+  --save_config [PATH]        Save current configuration to file
+  --example_config            Create an example configuration file
+  --list                      Display all airfoil available in the database :
+                              https://m-selig.ae.illinois.edu/ads/coord_database.html
+  --naca [4DIGITS]            NACA airfoil 4 digit
+  --airfoil [NAME]            Name of an airfoil profile in the database (database available with
+                              the --list argument)
+  --airfoil_path [PATH]       Path to custom airfoil .dat file
+  --flap_path [PATH]          Path to custom flap .dat file
+  --aoa [AOA]                 Angle of attack [deg] (default: 0 [deg])
+  --deflection [DEFLECTION]   Flap deflection angle [deg] (default: 0 [deg])
+  --farfield [RADIUS]         Create a circular farfield mesh of given radius [m] (default 10m)
+  --farfield_ctype            Generate a C-type structured farfield for hybrid meshes
+  --box [LENGTHxWIDTH]        Create a box mesh of dimensions [length]x[height] [m]
+  --airfoil_mesh_size [SIZE]  Mesh size of the airfoil contour [m] (default 0.01m)
+  --ext_mesh_size [SIZE]      Mesh size of the external domain [m] (default 0.2m)
+  --no_bl                     Do the unstructured meshing (with triangles), without a boundary
+                              layer
+  --first_layer [HEIGHT]      Height of the first layer [m] (default 3e-5m) (for bl and structured)
+  --ratio [RATIO]             Growth ratio of layers (default 1.2) (for bl and structured)
+  --nb_layers [INT]           Total number of layers in the boundary layer (default 35)
+  --format [FORMAT]           Format of the mesh file, e.g: msh, vtk, wrl, stl, mesh, cgns, su2,
+                              dat (default su2)
+  --structured                Generate a structured mesh
+  --arg_struc [LxL]           Parameters for the structured mesh [wake length (axis x)]x[total 
+                              height (axis y)] [m] (default 10x10)
+  --output [PATH]             Output path for the mesh file (default : current dir)
+  --ui                        Open GMSH user interface to see the mesh
+
+```
+
+## Configuration Files
+
+Instead of using command-line arguments, you can use configuration files for batch processing. Configuration files use a simple `key=value` format with support for comments.
+
+**Create an example configuration file:**
+
+```bash
+gmshairfoil2d --example_config
+```
+
+**Use a configuration file:**
+
+```bash
+gmshairfoil2d --config my_config.cfg
+```
+
+**Override config values with CLI arguments:**
+
+```bash
+gmshairfoil2d --config my_config.cfg --aoa 5.0
+```
+
+**Save current configuration to file:**
+
+```bash
+gmshairfoil2d --naca 0012 --aoa 5.0 --save_config my_config.cfg
+```
+
+For more details, see [example/CONFIG_README.md](example/CONFIG_README.md) and ready-to-use examples in [example/EXAMPLES_README.md](example/EXAMPLES_README.md).
+
+## Examples of use
+
+To check all airfoil available in the [database](https://m-selig.ae.illinois.edu/ads/coord_database.html):
+
+```bash
+gmshairfoil2d --list
+```
+
+For all the following examples, the default chord length is 1 meter.
+
+### Example 1: NACA0012 with circular farfield
+
+To create a circular farfield mesh around a NACA0012 of 10m of radius and see the result with GMSH user interface:
+
+```bash
+gmshairfoil2d --naca 0012 --farfield 10 --ui --no_bl
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example1_naca0012.cfg
+```
+
+![GMSH user interface with the 2D mesh](images/example_mesh.png)
+
+### Example 2: DAE11 with boundary layer
+
+To create a circular farfield mesh with boundary layer around a Drela DAE11 airfoil (the name in the database is "dae11") of 4m of radius with a mesh size of 0.005m on the airfoil:
+
+```bash
+gmshairfoil2d --airfoil dae11 --farfield 4 --airfoil_mesh_size 0.005
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example2_dae11.cfg
+```
+
+### Example 3: E211 in box with angle of attack
+
+To create mesh around an Eppler E211 airfoil (the name in the database is "e211") with an angle of attack of 8 degree in a box of 12x4m (length x height) and save it as a VTK mesh:
+
+```bash
+gmshairfoil2d --airfoil e211 --aoa 8 --box 12x4 --format vtk --ui --no_bl
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example3_e211_box.cfg
+```
+
+![GMSH user interface with the 2D mesh, rectangular box](images/example_mesh_box.png)
+
+### Example 4: CH10SM with box and boundary layer
+
+To create a boxed mesh around a Chuck Hollinger CH10SM airfoil (the name in the database is "ch10sm"), using the boundary layer with default parameters (first layer of height 3e-5, 35 layers and growth ratio of 1.2):
+
+```bash
+gmshairfoil2d --airfoil ch10sm --ui --box 2x1.4
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example4_ch10sm_bl.cfg
+```
+
+![GMSH result with 2D mesh with boundary layer, rectangular box](images/example_ch10sm_bl.png)
+
+### Example 5: NACA4220 structured mesh
+
+To create a structured mesh around a NACA4220 airfoil with first layer height of 0.01, mesh size of 0.08, wake length of 6, height of 7, and angle of attack of 6 degrees:
+
+```bash
+gmshairfoil2d --naca 4220 --airfoil_mesh_size 0.08 --ui --structured --first_layer 0.01 --arg_struc 6x7 --aoa 6
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example5_naca4220_structured.cfg
+```
+
+![GMSH result with 2D structured mesh](images/example_structured_naca4220.png)
+### Example 6: Custom airfoil from file
+
+To create a mesh around a custom airfoil profile with a deflected flap:
+
+```bash
+gmshairfoil2d --airfoil_path tests/test_data/NLR_7301.dat --flap_path tests/test_data/Flap_NLR_7301.dat --deflection 10 --box 4x3 --ui --no_bl
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example6_custom_airfoil_flap.cfg
+```
+
+This example shows how to load custom airfoil and flap profiles from external .dat files and generate a mesh with flap deflection, useful for using proprietary or custom-designed airfoil geometries.
+![GMSH result with 2D mesh around a custom flapped airfoil](images/example_flapped_airfoil.png)

gmshairfoil2d-0.2.31/README.md

@@ -0,0 +1,197 @@
+[![Pytest](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml)
+[![PyPi version](https://img.shields.io/pypi/v/gmshairfoil2d.svg)](https://pypi.python.org/pypi/gmshairfoil2d)
+[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://github.com/cfsengineering/GMSH-Airfoil-2D/blob/main/LICENSE)
+[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+# GMSH-Airfoil-2D
+
+Python tool to genreate 2D unstructured, hybrid and structured mesh around an airfoil with [GMSH](https://gmsh.info/) in one command line.
+
+## Installation
+
+You can install this package from PyPi:
+
+```bash
+pip install gmshairfoil2d
+```
+
+Or you can clone and install this repository with the following commands:
+
+```bash
+git clone https://github.com/cfsengineering/GMSH-Airfoil-2D.git
+cd GMSH-Airfoil-2D
+pip install -e .
+```
+
+## Usage
+
+```text
+gmshairfoil2d -h                                    
+
+optional arguments:
+  -h, --help                  Show this help message and exit
+  --config [PATH]             Path to configuration file (key=value format)
+  --save_config [PATH]        Save current configuration to file
+  --example_config            Create an example configuration file
+  --list                      Display all airfoil available in the database :
+                              https://m-selig.ae.illinois.edu/ads/coord_database.html
+  --naca [4DIGITS]            NACA airfoil 4 digit
+  --airfoil [NAME]            Name of an airfoil profile in the database (database available with
+                              the --list argument)
+  --airfoil_path [PATH]       Path to custom airfoil .dat file
+  --flap_path [PATH]          Path to custom flap .dat file
+  --aoa [AOA]                 Angle of attack [deg] (default: 0 [deg])
+  --deflection [DEFLECTION]   Flap deflection angle [deg] (default: 0 [deg])
+  --farfield [RADIUS]         Create a circular farfield mesh of given radius [m] (default 10m)
+  --farfield_ctype            Generate a C-type structured farfield for hybrid meshes
+  --box [LENGTHxWIDTH]        Create a box mesh of dimensions [length]x[height] [m]
+  --airfoil_mesh_size [SIZE]  Mesh size of the airfoil contour [m] (default 0.01m)
+  --ext_mesh_size [SIZE]      Mesh size of the external domain [m] (default 0.2m)
+  --no_bl                     Do the unstructured meshing (with triangles), without a boundary
+                              layer
+  --first_layer [HEIGHT]      Height of the first layer [m] (default 3e-5m) (for bl and structured)
+  --ratio [RATIO]             Growth ratio of layers (default 1.2) (for bl and structured)
+  --nb_layers [INT]           Total number of layers in the boundary layer (default 35)
+  --format [FORMAT]           Format of the mesh file, e.g: msh, vtk, wrl, stl, mesh, cgns, su2,
+                              dat (default su2)
+  --structured                Generate a structured mesh
+  --arg_struc [LxL]           Parameters for the structured mesh [wake length (axis x)]x[total 
+                              height (axis y)] [m] (default 10x10)
+  --output [PATH]             Output path for the mesh file (default : current dir)
+  --ui                        Open GMSH user interface to see the mesh
+
+```
+
+## Configuration Files
+
+Instead of using command-line arguments, you can use configuration files for batch processing. Configuration files use a simple `key=value` format with support for comments.
+
+**Create an example configuration file:**
+
+```bash
+gmshairfoil2d --example_config
+```
+
+**Use a configuration file:**
+
+```bash
+gmshairfoil2d --config my_config.cfg
+```
+
+**Override config values with CLI arguments:**
+
+```bash
+gmshairfoil2d --config my_config.cfg --aoa 5.0
+```
+
+**Save current configuration to file:**
+
+```bash
+gmshairfoil2d --naca 0012 --aoa 5.0 --save_config my_config.cfg
+```
+
+For more details, see [example/CONFIG_README.md](example/CONFIG_README.md) and ready-to-use examples in [example/EXAMPLES_README.md](example/EXAMPLES_README.md).
+
+## Examples of use
+
+To check all airfoil available in the [database](https://m-selig.ae.illinois.edu/ads/coord_database.html):
+
+```bash
+gmshairfoil2d --list
+```
+
+For all the following examples, the default chord length is 1 meter.
+
+### Example 1: NACA0012 with circular farfield
+
+To create a circular farfield mesh around a NACA0012 of 10m of radius and see the result with GMSH user interface:
+
+```bash
+gmshairfoil2d --naca 0012 --farfield 10 --ui --no_bl
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example1_naca0012.cfg
+```
+
+![GMSH user interface with the 2D mesh](images/example_mesh.png)
+
+### Example 2: DAE11 with boundary layer
+
+To create a circular farfield mesh with boundary layer around a Drela DAE11 airfoil (the name in the database is "dae11") of 4m of radius with a mesh size of 0.005m on the airfoil:
+
+```bash
+gmshairfoil2d --airfoil dae11 --farfield 4 --airfoil_mesh_size 0.005
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example2_dae11.cfg
+```
+
+### Example 3: E211 in box with angle of attack
+
+To create mesh around an Eppler E211 airfoil (the name in the database is "e211") with an angle of attack of 8 degree in a box of 12x4m (length x height) and save it as a VTK mesh:
+
+```bash
+gmshairfoil2d --airfoil e211 --aoa 8 --box 12x4 --format vtk --ui --no_bl
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example3_e211_box.cfg
+```
+
+![GMSH user interface with the 2D mesh, rectangular box](images/example_mesh_box.png)
+
+### Example 4: CH10SM with box and boundary layer
+
+To create a boxed mesh around a Chuck Hollinger CH10SM airfoil (the name in the database is "ch10sm"), using the boundary layer with default parameters (first layer of height 3e-5, 35 layers and growth ratio of 1.2):
+
+```bash
+gmshairfoil2d --airfoil ch10sm --ui --box 2x1.4
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example4_ch10sm_bl.cfg
+```
+
+![GMSH result with 2D mesh with boundary layer, rectangular box](images/example_ch10sm_bl.png)
+
+### Example 5: NACA4220 structured mesh
+
+To create a structured mesh around a NACA4220 airfoil with first layer height of 0.01, mesh size of 0.08, wake length of 6, height of 7, and angle of attack of 6 degrees:
+
+```bash
+gmshairfoil2d --naca 4220 --airfoil_mesh_size 0.08 --ui --structured --first_layer 0.01 --arg_struc 6x7 --aoa 6
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example5_naca4220_structured.cfg
+```
+
+![GMSH result with 2D structured mesh](images/example_structured_naca4220.png)
+### Example 6: Custom airfoil from file
+
+To create a mesh around a custom airfoil profile with a deflected flap:
+
+```bash
+gmshairfoil2d --airfoil_path tests/test_data/NLR_7301.dat --flap_path tests/test_data/Flap_NLR_7301.dat --deflection 10 --box 4x3 --ui --no_bl
+```
+
+Or using config file:
+
+```bash
+gmshairfoil2d --config example/example6_custom_airfoil_flap.cfg
+```
+
+This example shows how to load custom airfoil and flap profiles from external .dat files and generate a mesh with flap deflection, useful for using proprietary or custom-designed airfoil geometries.
+![GMSH result with 2D mesh around a custom flapped airfoil](images/example_flapped_airfoil.png)

gmshairfoil2d-0.2.31/gmshairfoil2d/__init__.py

@@ -0,0 +1,3 @@
+"""GMSH-Airfoil-2D: 2D airfoil mesh generation with GMSH."""
+
+__version__ = "1.0.0"

gmshairfoil2d-0.2.31/gmshairfoil2d/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for the gmshairfoil2d package."""
+
+from gmshairfoil2d.gmshairfoil2d import main
+
+if __name__ == "__main__":
+    main()