PegasusTools¶
Summary¶
PegasusTools is an analysis
package for the Pegasus++ Particle-In-Cell (PIC) code. It can be easily
installed with pip install pegasustools or uv pip install pegasustools. The
documentation for the latest stable version can be found
here. Once installed it can be
imported directly into any Python program via import pegasustools as pt
Found a Bug or Have a Feature Request?¶
Please open an issue and we’ll figure out a solution.
Contributing¶
If you wish to contribute please review the contribution guide in CONTRIBUTING.md. All contributions need to come via pull requests. I recommend you fork this repo, make your changes, then submit a PR from your feature branch.
Citation¶
If PegasusTools has been significant to a project that leads to an academic
publication, please acknowledge our work by citing it using the information in
the included citation.cff file; citations in APA or BibTex format can be found
in the “About” section of the GitHub repository.