Metadata-Version: 2.1
Name: polymesh
Version: 0.0.3
Summary: A Python package to build, manipulate and analyze polygonal meshes.
Home-page: https://github.com/dewloosh/PolyMesh
Author: dewloosh
Author-email: dewloosh@gmail.com
License: UNKNOWN
Download-URL: https://github.com/dewloosh/PolyMesh/archive/refs/tags/0.0.3.zip
Description: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dewloosh/PolyMesh/main?labpath=examples%2Flpp.ipynb?urlpath=lab)
        [![CircleCI](https://circleci.com/gh/dewloosh/PolyMesh.svg?style=shield)](https://circleci.com/gh/dewloosh/PolyMesh) 
        [![Documentation Status](https://readthedocs.org/projects/PolyMesh/badge/?version=latest)](https://PolyMesh.readthedocs.io/en/latest/?badge=latest) 
        [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
        [![PyPI](https://badge.fury.io/py/PolyMesh.svg)](https://pypi.org/project/PolyMesh) 
        
        # **PolyMesh** - A Python Library for Compound Meshes with Jagged Topologies
        
        > **Warning**
        > This package is under active development and in an **beta stage**. Come back later, or star the repo to make sure you donâ€™t miss the first stable release!
        
        ## **Documentation**
        
        Click [here](https://PolyMesh.readthedocs.io/en/latest/) to read the documentation.
        
        ## **Installation**
        This is optional, but we suggest you to create a dedicated virtual enviroment at all times to avoid conflicts with your other projects. Create a folder, open a command shell in that folder and use the following command
        
        ```console
        >>> python -m venv venv_name
        ```
        
        Once the enviroment is created, activate it via typing
        
        ```console
        >>> .\venv_name\Scripts\activate
        ```
        
        `PolyMesh` can be installed (either in a virtual enviroment or globally) from PyPI using `pip` on Python >= 3.6:
        
        ```console
        >>> pip install polymesh
        ```
        
        ## **Testing**
        
        To run all tests, open up a console in the root directory of the project and type the following
        
        ```console
        >>> python -m unittest
        ```
        
        ## **Dependencies**
        
        must have 
          * `Numba`, `NumPy`, `SciPy`, `SymPy`, `awkward`
        
        optional 
          * `networkx`
        
        ## **License**
        
        This package is licensed under the MIT license.
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7, <3.10
Description-Content-Type: text/markdown
