PyHOPE 0.8.0__tar.gz → 0.9.0__tar.gz

pyhope-0.8.0/README.md → pyhope-0.9.0/PKG-INFO

@@ -1,11 +1,46 @@
+Metadata-Version: 2.4
+Name: PyHOPE
+Version: 0.9.0
+Summary: Python High-Order Preprocessing Environment
+License: GPL-3.0-only
+License-File: AUTHORS.md
+License-File: LICENSE.md
+Keywords: PyHOPE,mesh generator
+Author: Numerics Research Group (NRG)
+Author-email: numerics@iag.uni-stuttgart.de
+Requires-Python: >=3.10
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: POSIX :: Linux
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: numba
+Requires-Dist: alive-progress
+Requires-Dist: gmsh
+Requires-Dist: h5py
+Requires-Dist: hilbertcurve
+Requires-Dist: meshio
+Requires-Dist: numba ; extra == "numba"
+Requires-Dist: numpy (>=2.0.0)
+Requires-Dist: packaging
+Requires-Dist: plotext
+Requires-Dist: scipy
+Requires-Dist: typing-extensions
+Project-URL: Documentation, https://hopr-framework.github.io/PyHOPE
+Project-URL: Homepage, https://numericsresearchgroup.org
+Project-URL: Repository, https://github.com/hopr-framework/pyhope
+Description-Content-Type: text/markdown
+
 PyHOPE (Python High-Order Preprocessing Environment) is an open-source Python framework for the generation of three-dimensional unstructured high-order meshes. These meshes are needed by high-order numerical methods like Discontinuous Galerkin, Spectral Element Methods, or pFEM, in order to retain their accuracy if the computational domain includes curved boundaries.
 
 PyHOPE has been developed by the Numerics Research Group (NRG) lead by Prof. Andrea Beck at the Institute of Aerodynamics and Gas Dynamics at the University of Stuttgart, Germany.
 
 PyHOPE is heavily inspired by [HOPR (High Order Preprocessor)](https://github.com/hopr-framework/hopr) and shares the same input/output format. Furthermore, PyHOPE utilizes [Gmsh](https://gmsh.info) for the initial mesh generation and conversion before converting it to its internal representation. The internal representation is loosely based on [meshio](https://github.com/nschloe/meshio) but augmented with additional information required for high-order meshes.
 
-This is a scientific project. If you use PyHOPE for publications or presentations in science, please support the project by citing our publications given at [numericsresearchgroup.org](https://numericsresearchgroup.org/publications.html).
-
 # Installation
 PyHOPE is built using standard Python packages. You can install PyHOPE by following these steps. 
 
@@ -26,6 +61,12 @@ PyHOPE is built using standard Python packages. You can install PyHOPE by follow
     python -m pip install pyhope
     ```
 
+> [!NOTE]  
+> PyHOPE can optionally use [Numba](https://numba.pydata.org) to accelerate some compute-heavy routines. If Numba is not available in your environment, PyHOPE will fall back to pure NumPy implementations.
+> ```bash
+> python -m pip install pyhope[numba]
+> ```
+
 # Testing
 PyHOPE features internal health checks to verify that everything works as expected. The checks can be invoked directly from the terminal.
 ```bash
@@ -185,3 +226,30 @@ with Mesh('1-01-cartbox_mesh.h5') as m:
     elems = m.elems
     lobatto_nodes = Basis.legendre_gauss_lobatto_nodes(order=m.nGeo)
 ```
+
+# Cite
+This is a scientific project. If you use PyHOPE for publications or presentations in science, please support the project by citing the following article.
+```bibtex
+@article{kopper2025pyhope:joss,
+  title        = {{PyHOPE}: A Python Toolkit for Three-Dimensional Unstructured High-Order Meshes},
+  author       = {Kopper, Patrick and Blind, Marcel P. and Schwarz, Anna and Kurz, Marius and Rodach, Felix and Copplestone, Stephen M. and Beck, Andrea D.},
+  journal      = {Journal of Open Source Software},
+  year         = {2025},
+  volume       = {10}, 
+  number       = {115}, 
+  pages        = {8769},
+  publisher    = {The Open Journal},
+  doi          = {10.21105/joss.08769}
+}
+```
+In addition, you can also directly refer to this repository as
+```bibtex
+@misc{kopper2025pyhope:repo,
+  title        = {{PyHOPE}: A Python Toolkit for Three-Dimensional Unstructured High-Order Meshes},
+  author       = {Kopper, Patrick and Blind, Marcel P. and Schwarz, Anna and Kurz, Marius and Rodach, Felix and Copplestone, Stephen M. and Beck, Andrea D.},
+  year         = {2025},
+  howpublished = {\url{https://github.com/hopr-framework/PyHOPE}},
+  doi          = {10.5281/zenodo.17414843}
+}
+```
+

pyhope-0.8.0/PKG-INFO → pyhope-0.9.0/README.md

@@ -1,45 +1,9 @@
-Metadata-Version: 2.4
-Name: PyHOPE
-Version: 0.8.0
-Summary: Python High-Order Preprocessing Environment
-License: GPL-3.0-only
-License-File: AUTHORS.md
-License-File: LICENSE.md
-Keywords: PyHOPE,mesh generator
-Author: Numerics Research Group (NRG)
-Author-email: numerics@iag.uni-stuttgart.de
-Requires-Python: >=3.10
-Classifier: Development Status :: 3 - Alpha
-Classifier: Operating System :: POSIX :: Linux
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: alive-progress
-Requires-Dist: gmsh
-Requires-Dist: h5py
-Requires-Dist: hilbertcurve
-Requires-Dist: meshio
-Requires-Dist: numpy (>=2.0.0)
-Requires-Dist: packaging
-Requires-Dist: plotext
-Requires-Dist: scipy
-Requires-Dist: typing-extensions
-Project-URL: Documentation, https://hopr-framework.github.io/PyHOPE
-Project-URL: Homepage, https://numericsresearchgroup.org
-Project-URL: Repository, https://github.com/hopr-framework/pyhope
-Description-Content-Type: text/markdown
-
 PyHOPE (Python High-Order Preprocessing Environment) is an open-source Python framework for the generation of three-dimensional unstructured high-order meshes. These meshes are needed by high-order numerical methods like Discontinuous Galerkin, Spectral Element Methods, or pFEM, in order to retain their accuracy if the computational domain includes curved boundaries.
 
 PyHOPE has been developed by the Numerics Research Group (NRG) lead by Prof. Andrea Beck at the Institute of Aerodynamics and Gas Dynamics at the University of Stuttgart, Germany.
 
 PyHOPE is heavily inspired by [HOPR (High Order Preprocessor)](https://github.com/hopr-framework/hopr) and shares the same input/output format. Furthermore, PyHOPE utilizes [Gmsh](https://gmsh.info) for the initial mesh generation and conversion before converting it to its internal representation. The internal representation is loosely based on [meshio](https://github.com/nschloe/meshio) but augmented with additional information required for high-order meshes.
 
-This is a scientific project. If you use PyHOPE for publications or presentations in science, please support the project by citing our publications given at [numericsresearchgroup.org](https://numericsresearchgroup.org/publications.html).
-
 # Installation
 PyHOPE is built using standard Python packages. You can install PyHOPE by following these steps. 
 
@@ -60,6 +24,12 @@ PyHOPE is built using standard Python packages. You can install PyHOPE by follow
     python -m pip install pyhope
     ```
 
+> [!NOTE]  
+> PyHOPE can optionally use [Numba](https://numba.pydata.org) to accelerate some compute-heavy routines. If Numba is not available in your environment, PyHOPE will fall back to pure NumPy implementations.
+> ```bash
+> python -m pip install pyhope[numba]
+> ```
+
 # Testing
 PyHOPE features internal health checks to verify that everything works as expected. The checks can be invoked directly from the terminal.
 ```bash
@@ -220,3 +190,28 @@ with Mesh('1-01-cartbox_mesh.h5') as m:
     lobatto_nodes = Basis.legendre_gauss_lobatto_nodes(order=m.nGeo)
 ```
 
+# Cite
+This is a scientific project. If you use PyHOPE for publications or presentations in science, please support the project by citing the following article.
+```bibtex
+@article{kopper2025pyhope:joss,
+  title        = {{PyHOPE}: A Python Toolkit for Three-Dimensional Unstructured High-Order Meshes},
+  author       = {Kopper, Patrick and Blind, Marcel P. and Schwarz, Anna and Kurz, Marius and Rodach, Felix and Copplestone, Stephen M. and Beck, Andrea D.},
+  journal      = {Journal of Open Source Software},
+  year         = {2025},
+  volume       = {10}, 
+  number       = {115}, 
+  pages        = {8769},
+  publisher    = {The Open Journal},
+  doi          = {10.21105/joss.08769}
+}
+```
+In addition, you can also directly refer to this repository as
+```bibtex
+@misc{kopper2025pyhope:repo,
+  title        = {{PyHOPE}: A Python Toolkit for Three-Dimensional Unstructured High-Order Meshes},
+  author       = {Kopper, Patrick and Blind, Marcel P. and Schwarz, Anna and Kurz, Marius and Rodach, Felix and Copplestone, Stephen M. and Beck, Andrea D.},
+  year         = {2025},
+  howpublished = {\url{https://github.com/hopr-framework/PyHOPE}},
+  doi          = {10.5281/zenodo.17414843}
+}
+```