diff options
| author | Rajdeep Adak | 2024-03-24 17:53:26 -0700 |
|---|---|---|
| committer | GitHub | 2024-03-24 17:53:26 -0700 |
| commit | e6a3ff53e61aad07a081343b884b6d176cd97fa7 (patch) | |
| tree | e3edccc679d82037571b9770df63d5c78c9e18b8 | |
| parent | 10a163269ffd184c30b36e3863a65004f47404ca (diff) | |
| download | pyvnt-e6a3ff53e61aad07a081343b884b6d176cd97fa7.tar.gz pyvnt-e6a3ff53e61aad07a081343b884b6d176cd97fa7.tar.bz2 pyvnt-e6a3ff53e61aad07a081343b884b6d176cd97fa7.zip | |
Update README.md
| -rw-r--r-- | README.md | 21 |
1 files changed, 7 insertions, 14 deletions
@@ -1,20 +1,13 @@ -# PyVnt : Python Venturial Node Trees +# PyVNT : Python Venturial Node Trees -PyVnt aims to represent OpenFOAM files in form of Node trees using python. - -OpenFOAM case files are primarity in `.txt` format, which makes them difficult to parse and automate the process of case file generation using a GUI. PyVnt aims to ease this process by handling the data in the OpenFOAM case files and store then in the form of Node trees using python. - -This project is an extension of the [Venturial](https://github.com/FOSSEE/venturial) project as currently there is no middleware to handle the data generated by Venturial outside of Blender. PyVnt aims to be the middleware between the GUI application and the OpenFOAM case files. - -PyVnt seeks to provide a medium to handle data from OpenFOAM case files in python, acting as a middleware for any other python based application focused on easing the process of OpenFOAM case generation. +PyVNT is a library to control [Venturial's](https://github.com/FOSSEE/venturial) Node-Tree based data structure using Python. Primarily, PyVNT serves as a dependency to Venturial but it can also be used independently. PyVNT contains classes that define the Node-tree data structure and modules for manipulating it. ## Features -The main features fo pyvnt package are: - -1. Make Node trees that mimic the scructure of OpenFOAM Dictionary data structure. -2. Map multiple values to a single key as it is done in a OpenFOAM dictionary. -3. Dynamically edit the Node trees once they are created. +The main features of PyVNT are: +1. Make Node trees that mimic the structure of OpenFOAM Dictionaries. +2. Provide tools for conveniently manipulating trees with simple Python scripts. +3. Generate serialised data for dynamically generating graphical representation of trees. ## Installation @@ -223,4 +216,4 @@ fvSolutions } ``` -
\ No newline at end of file + |