Metadata-Version: 2.1
Name: struphy
Version: 1.9.9
Summary: Multi-model plasma physics package
Author: Max Planck Institute for Plasma Physics
Author-email: stefan.possanner@ipp.mpg.de, florian.holderied@ipp.mpg.de
License: Copyright 2019 (c) Struphy dev team | Max Planck Institute for Plasma Physics
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
        associated documentation files (the "Software"), to deal in the Software without restriction, 
        including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
        and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial 
        portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 
        NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
        SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        In addition, we ask you to cite the following reference inscientific publications which contain
        results obtained with this software and developments:
        
        F. Holderied, S. Possanner, X. Wang, 
        "MHD-kinetic hybrid code based on structure-preserving finite elements with particles-in-cell",
        J. Comp. Phys. 433 (2021) 110143
        
Project-URL: homepage, https://struphy.pages.mpcdf.de/struphy/
Project-URL: documentation, https://struphy.pages.mpcdf.de/struphy/
Project-URL: repository, https://gitlab.mpcdf.mpg.de/struphy/struphy
Project-URL: changelog, https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/CHANGELOG.md
Project-URL: Bug Tracker, https://gitlab.mpcdf.mpg.de/struphy/struphy/-/issues
Keywords: plasma physics, fusion, numerical modeling, partial differential equations, energetic particles
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: mpi4py
Requires-Dist: numpy
Requires-Dist: pyccel
Requires-Dist: PyYAML
Requires-Dist: scipy
Requires-Dist: pytest
Requires-Dist: pytest-mpi
Requires-Dist: mistune (<2)
Requires-Dist: sphinx (==4.2.0)
Requires-Dist: sphinxcontrib-napoleon
Requires-Dist: sphinx-rtd-theme
Requires-Dist: m2r2 (==0.3.1)
Requires-Dist: vtk
Requires-Dist: docutils (==0.15)
Requires-Dist: wheel
Requires-Dist: tqdm
Requires-Dist: gvec-to-python (>=1.1.0)

# STRUPHY - STRUcture-Preserving HYbrid codes

A Python package for energetic particles in plasma.

The package is developed since 2019 at [Max Planck Institute for Plasma Physics](https://www.ipp.mpg.de/) 
in the division [NMPP (Numerical Methods for Plasma Physics)](https://www.ipp.mpg.de/ippcms/de/for/bereiche/numerik).

## What you can do with struphy

* Solve a variety of [plasma physics PDEs](https://struphy.pages.mpcdf.de/struphy/sections/models.html) with fluid and/or kinetic components on [curved domains](https://struphy.pages.mpcdf.de/struphy/sections/domains.html) 
* [Post process](https://struphy.pages.mpcdf.de/struphy/sections/userguide.html#post-processing) data and generate `.vtk` files for 3d views
* Add your own [model equations](https://struphy.pages.mpcdf.de/struphy/sections/developers.html#model-equations) or [physics feature](https://struphy.pages.mpcdf.de/struphy/sections/developers.html#how-to-add) 

## Algorithmic features

* Particle-in-cell method for kinetic species
* Discrete differential forms based on high-order B-spline finite elements ([Psydac library](https://github.com/pyccel/psydac)) for fields/fluids
* Exact conservation laws
* Polar splines to treat a polar singularity 
* Kernels are pre-compiled with [Pyccel](https://github.com/pyccel/pyccel) to achieve near-Fortran performance
* MPI/OpenMP hybrid parallelization  

## Installation

* See the [struphy documentation](https://struphy.pages.mpcdf.de/struphy/index.html).

## Key references

* F. Holderied, S. Possanner, X. Wang, "MHD-kinetic hybrid code based on structure-preserving finite elements with particles-in-cell", [J. Comp. Phys. 433 (2021) 110143](https://www.sciencedirect.com/science/article/pii/S0021999121000358?via%3Dihub)

* F. Holderied, S. Possanner, "Magneto-hydrodynamic eigenvalue solver for axis-symmetric equilibria based on smooth polar splines", [J. Comp. Phys. 464 (2022) 111329](https://www.sciencedirect.com/science/article/pii/S0021999122003916?via%3Dihub)

* F. Holderied, "STRUPHY: a structure-preserving hybrid MHD-kinetic code for the interaction of energetic particles with Alfvén waves in magnetized plasmas", [PhD thesis (2022)](https://mediatum.ub.tum.de/?id=1656539)

## License

Copyright 2022 (c) struphy dev team | CONTRIBUTING.md | Max Planck Institute for Plasma Physics

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

In addition, we ask you to cite the following reference in scientific publications which contain results obtained with
this software and developments:

F. Holderied, S. Possanner, X. Wang, "MHD-kinetic hybrid code based on structure-preserving finite elements with particles-in-cell", J. Comp. Phys. 433 (2021) 110143

## Contact

* Florian Holderied [floho@ipp.mpg.de](floho@ipp.mpg.de)
* Stefan Possanner [spossann@ipp.mpg.de](spossann@ipp.mpg.de)
* Xin Wang [xin.wang@ipp.mpg.de](xin.wang@ipp.mpg.de)
