Skip to content

Files

Latest commit

Sad-AbdSad-Abd
Updated Roadmap on README
Nov 7, 2023
2e479b3 · Nov 7, 2023

History

History
151 lines (106 loc) · 4.63 KB

README.md

File metadata and controls

151 lines (106 loc) · 4.63 KB

License Made with love in SUT (Iran) GitHub Stars


Logo

pyPolyMesher

Generation of polygonal Mesh
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
    1. Read Image
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

pyPolyMesher is a Python library for polygon mesh generation based on MATLAB PolyMesher program.

Example Mesh

(back to top)

Getting Started

This part explains how to install and use this package.

Installation

to be added

(back to top)

Usage

to be added

(back to top)

Roadmap

Section 1 - Current Focus and Issue Resolution

  1. Translate other domain codes.
  2. Add docstrings and comments to the following files:
    • pyPolyMesher
    • pydFunction
    • Domains
  3. Make the resequence function work properly (Issue #3).
  4. Transform Domain definitions into classes using Object-Oriented Programming (OOP) principles.
  5. Rethink the file hierarchy and user experience.

Section 2 - Upcoming Priorities

  1. Use Jupyter notebook for Examples.py.
  2. Use Jupyter notebook to illustrate Domain creation.
  3. Add some example meshes to the README.
  4. Enhance the README with more detailed information.
  5. Publish the package on PYPI and Zenodo for wider distribution.
  6. Add some tests.

Section 3 - Vision and Future Prospects

  1. Define Domain from dxf files.
  2. Develop a GUI for domain definition to improve user interaction.
  3. Explore and brainstorm alternative options for domain definition and future possible expansions.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". We appreciate your interest in pyPolyMesher!. Don't forget to give the project a star! Thanks again!

(back to top)

License

This project is licensed under the GPLv3 License - see the LICENSE file for details. Contact

(back to top)

Contact

If you have any questions or feedback, feel free to reach out:

Email: [email protected]

GitHub: Sad-Abd