Conversation
Expanded and reorganized the README with clearer installation, usage, and project structure sections, and added author and acknowledgements.
Replaces the JavaScript-based image gallery with a Markdown table and collapsible section for screenshots. This improves compatibility with GitHub's Markdown renderer and makes the gallery easier to maintain.
Major refactor of src/vlm/app.py to improve code organization, error handling, and resource management. Moves data files to src/vlm/data/, updates import paths, adds config_manager integration, and enhances session/thread safety. Removes obsolete cache and __pycache__ files, and updates templates and static assets to match new structure. New design interface and save/load management system.
JaviLendi
added
documentation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request primarily updates the
README.mdto improve project documentation, making it more user-friendly and comprehensive. It also adds new sample airfoil data and a configuration file to thesrc/vlm/datadirectory, supporting easier usage and testing of the VLM (Vortex Lattice Method) codebase.This pull request makes a big change in the design of the interface, making it more user friendly.
Documentation improvements:
README.md, including clearer installation instructions, a new "Usage" section, a detailed project structure, author information, and enhanced acknowledgements. Screenshots and step-by-step guides have been added to make onboarding and usage easier for new users. [1] [2] [3] [4]Data additions for airfoil and configuration support:
3215.csv,4215.csv) and corresponding metadata (3215.json,4215.json) tosrc/vlm/data/saved_airfoils/, enabling out-of-the-box airfoil analysis and testing. [1] [2] [3] [4]AlaConHTPyVTP.json) insrc/vlm/data/saved_configs/, providing a ready-to-use aircraft configuration for simulations and demonstrations.cache_plane_variables.txt) to support efficient re-use of wing section parameters in VLM calculations.