struphy 2.4.0__tar.gz → 2.4.2__tar.gz

{struphy-2.4.0/src/struphy.egg-info → struphy-2.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: struphy
-Version: 2.4.0
+Version: 2.4.2
 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
@@ -42,7 +42,6 @@ Requires-Dist: tqdm
 Requires-Dist: argcomplete
 Requires-Dist: gvec-to-python
 Requires-Dist: desc-opt
-Requires-Dist: netcdf4<1.7
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-mpi; extra == "test"
@@ -68,12 +67,53 @@ Requires-Dist: myst-parser; extra == "doc"
 Requires-Dist: mistune; extra == "doc"
 Requires-Dist: docutils; extra == "doc"
 Requires-Dist: ipyparallel; extra == "doc"
+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 -U virtualenv
+    python3 -m venv struphy_env
+    source struphy_env/bin/activate
+
+Install latest release (with test packages):
+
+    pip install --no-cache-dir -U struphy[test]
+
+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.2/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 -U virtualenv
+    python3 -m venv struphy_env
+    source struphy_env/bin/activate
+
+Install latest release (with test packages):
+
+    pip install --no-cache-dir -U struphy[test]
+
+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.0 → struphy-2.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "struphy"
-version = "2.4.0"
+version = "2.4.2"
 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',
@@ -31,7 +31,6 @@ dependencies = [
     'argcomplete',
     'gvec-to-python',
     'desc-opt',
-    'netcdf4<1.7',
 ]
 
 [project.optional-dependencies]
@@ -74,6 +73,7 @@ changelog = "https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/CHANGELOG.
 
 [project.scripts]
 struphy = "struphy.console.main:struphy"
+kinetic-diagnostics = "struphy.diagnostics.console_diagn:main"
 
 [tool.setuptools.package-data]
 'struphy.fields_background.mhd_equil.eqdsk' = [
@@ -95,10 +95,11 @@ struphy = "struphy.console.main:struphy"
                     'tests/*.yml',
                     'tutorials/*.yml',
                     'longer_examples/*.yml',
+                    'verification/*.yml',
                     ]
                     
 struphy = ['compile_struphy.mk',
-           'psydac-2.4.0-py3-none-any.whl',]
+           'psydac-2.4.2.dev0-py3-none-any.whl',]
 
 [tool.autopep8]
 # Add specific settings for autopep8