struphy 2.4.1__tar.gz → 2.4.3__tar.gz

{struphy-2.4.1/src/struphy.egg-info → struphy-2.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: struphy
-Version: 2.4.1
+Version: 2.4.3
 Summary: Multi-model plasma physics package
 Author: Max Planck Institute for Plasma Physics
 Author-email: stefan.possanner@ipp.mpg.de, eric.sonnendruecker@ipp.mpg.de
@@ -32,7 +32,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: pyccel>=1.11.1
-Requires-Dist: mpi4py<4
+Requires-Dist: mpi4py
 Requires-Dist: scipy
 Requires-Dist: h5py
 Requires-Dist: matplotlib
@@ -40,13 +40,12 @@ Requires-Dist: pyyaml
 Requires-Dist: vtk
 Requires-Dist: tqdm
 Requires-Dist: argcomplete
-Requires-Dist: gvec-to-python
-Requires-Dist: desc-opt
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-mpi; extra == "test"
+Requires-Dist: pytest
+Requires-Dist: pytest-mpi
+Provides-Extra: phys
+Requires-Dist: gvec-to-python; extra == "phys"
+Requires-Dist: desc-opt; extra == "phys"
 Provides-Extra: dev
-Requires-Dist: struphy[test]; extra == "dev"
 Requires-Dist: notebook; extra == "dev"
 Requires-Dist: autopep8; extra == "dev"
 Requires-Dist: isort; extra == "dev"
@@ -55,7 +54,10 @@ Requires-Dist: pylint; extra == "dev"
 Requires-Dist: add-trailing-comma; extra == "dev"
 Requires-Dist: ruff>=0.9.1; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: nbstripout; extra == "dev"
+Requires-Dist: tabulate; extra == "dev"
 Provides-Extra: doc
+Requires-Dist: struphy[phys]; extra == "doc"
 Requires-Dist: sphinx; extra == "doc"
 Requires-Dist: sphinx-design; extra == "doc"
 Requires-Dist: lxml_html_clean; extra == "doc"
@@ -67,12 +69,59 @@ Requires-Dist: myst-parser; extra == "doc"
 Requires-Dist: mistune; extra == "doc"
 Requires-Dist: docutils; extra == "doc"
 Requires-Dist: ipyparallel; extra == "doc"
+Provides-Extra: likwid
+Requires-Dist: struphy[dev]; extra == "likwid"
+Requires-Dist: kaleido; extra == "likwid"
+Requires-Dist: pylikwid; extra == "likwid"
+Requires-Dist: pandas; extra == "likwid"
+Requires-Dist: plotly; extra == "likwid"
+Dynamic: license-file
 
 # Struphy - Structure-preserving hybrid codes
 
 A Python package for plasma physics PDEs.
 
-See the [Struphy documentation](https://struphy.pages.mpcdf.de/struphy/index.html) for details.
+Join the [Struphy mailing list](https://listserv.gwdg.de/mailman/listinfo/struphy) and stay informed on updates.
+
+## Documentation
+See the [Struphy pages](https://struphy.pages.mpcdf.de/struphy/index.html) for details regarding installation, tutorials, use and development.
+
+## Quick install
+
+Use a virtual environment:
+
+    python3 -m pip install --upgrade virtualenv
+    python3 -m venv struphy_env
+    source struphy_env/bin/activate
+
+Install latest release:
+
+    pip install --no-cache-dir --upgrade struphy
+
+Compile kernels:
+
+    struphy compile
+
+Quick help:
+
+    struphy -h
+
+In case of problems visit [Trouble shooting](https://struphy.pages.mpcdf.de/struphy/sections/install.html#trouble-shooting).
+
+## Run tests from the command-line
+
+Run available verification tests for [Struphy models](https://struphy.pages.mpcdf.de/struphy/sections/models.html):
+
+    struphy test models --verification --fast --show-plots 
+
+The corresponding parameter files are in [struphy/io/inp/verification/](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/tree/devel/src/struphy/io/inp/verification).
+The corresponding diagnostics functions are in [struphy/models/tests/verification.py](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/src/struphy/models/tests/verification.py). You can repeat the verification run of a single `<model_name>` by typing
+
+    struphy test <model_name> --verification --fast --show-plots 
+
+## Tutorial notebooks
+
+Struphy tutorials are available in the form of [Jupyter notebooks](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/tree/devel/doc/tutorials).  
 
 ## Reference paper
 

struphy-2.4.3/README.md

@@ -0,0 +1,55 @@
+# Struphy - Structure-preserving hybrid codes
+
+A Python package for plasma physics PDEs.
+
+Join the [Struphy mailing list](https://listserv.gwdg.de/mailman/listinfo/struphy) and stay informed on updates.
+
+## Documentation
+See the [Struphy pages](https://struphy.pages.mpcdf.de/struphy/index.html) for details regarding installation, tutorials, use and development.
+
+## Quick install
+
+Use a virtual environment:
+
+    python3 -m pip install --upgrade virtualenv
+    python3 -m venv struphy_env
+    source struphy_env/bin/activate
+
+Install latest release:
+
+    pip install --no-cache-dir --upgrade struphy
+
+Compile kernels:
+
+    struphy compile
+
+Quick help:
+
+    struphy -h
+
+In case of problems visit [Trouble shooting](https://struphy.pages.mpcdf.de/struphy/sections/install.html#trouble-shooting).
+
+## Run tests from the command-line
+
+Run available verification tests for [Struphy models](https://struphy.pages.mpcdf.de/struphy/sections/models.html):
+
+    struphy test models --verification --fast --show-plots 
+
+The corresponding parameter files are in [struphy/io/inp/verification/](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/tree/devel/src/struphy/io/inp/verification).
+The corresponding diagnostics functions are in [struphy/models/tests/verification.py](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/src/struphy/models/tests/verification.py). You can repeat the verification run of a single `<model_name>` by typing
+
+    struphy test <model_name> --verification --fast --show-plots 
+
+## Tutorial notebooks
+
+Struphy tutorials are available in the form of [Jupyter notebooks](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/tree/devel/doc/tutorials).  
+
+## Reference paper
+
+* S. Possanner, F. Holderied, Y. Li, B.-K. Na, D. Bell, S. Hadjout and Y. Güçlü, [**High-Order Structure-Preserving Algorithms for Plasma Hybrid Models**](https://link.springer.com/chapter/10.1007/978-3-031-38299-4_28), International Conference on Geometric Science of Information 2023, 263-271, Springer Nature Switzerland.
+
+## Contact
+
+* Stefan Possanner [stefan.possanner@ipp.mpg.de](mailto:spossann@ipp.mpg.de)
+* Eric Sonnendrücker [eric.sonnendruecker@ipp.mpg.de](mailto:eric.sonnendruecker@ipp.mpg.de)
+* Xin Wang [xin.wang@ipp.mpg.de](mailto:xin.wang@ipp.mpg.de)

{struphy-2.4.1 → struphy-2.4.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "struphy"
-version = "2.4.1"
+version = "2.4.3"
 readme = "README.md"
 requires-python = ">=3.10"
 license = {file = "LICENSE"}
@@ -21,7 +21,7 @@ classifiers = [
 dependencies = [
     'numpy',
     'pyccel>=1.11.1',
-    'mpi4py<4',
+    'mpi4py',
     'scipy',
     'h5py',
     'matplotlib',
@@ -29,17 +29,16 @@ dependencies = [
     'vtk',
     'tqdm',
     'argcomplete',
-    'gvec-to-python',
-    'desc-opt',
+    'pytest',
+    'pytest-mpi',
 ]
 
 [project.optional-dependencies]
-test = [
-    'pytest',
-    'pytest-mpi',
+phys = [
+    'gvec-to-python',
+    'desc-opt',
 ]
 dev = [
-    'struphy[test]',
     'notebook',
     'autopep8',
     'isort',
@@ -48,8 +47,11 @@ dev = [
     'add-trailing-comma',
     'ruff>=0.9.1',
     'pre-commit',
+    'nbstripout',
+    'tabulate',
 ]
 doc = [
+    'struphy[phys]',
     'sphinx',
     'sphinx-design',
     'lxml_html_clean',
@@ -62,6 +64,13 @@ doc = [
     'docutils',
     'ipyparallel',
 ]
+likwid = [
+    'struphy[dev]',
+    'kaleido',
+    'pylikwid',
+    'pandas',
+    'plotly',
+]
 
 
 [project.urls]
@@ -99,7 +108,7 @@ kinetic-diagnostics = "struphy.diagnostics.console_diagn:main"
                     ]
                     
 struphy = ['compile_struphy.mk',
-           'psydac-2.4.1-py3-none-any.whl',]
+           'psydac-2.4.3.dev0-py3-none-any.whl',]
 
 [tool.autopep8]
 # Add specific settings for autopep8