pegasustools

Analysis package for the Pegasus PIC code.

https://github.com/pegasuspic/pegasustools

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Analysis package for the Pegasus PIC code.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 22
Created over 1 year ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

PegasusTools

Actions Status pre-commit.ci status Documentation Status

PyPI version PyPI platforms Code style: Ruff

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.

Bibliography

Owner

  • Name: PegasusPIC
  • Login: PegasusPIC
  • Kind: organization

This is the organization for things related to the Pegasus Particles-in-Cell (PIC) code.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: PegasusTools
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Robert
    family-names: Caddy
    email: rcaddy@princeton.edu
    affiliation: 'Princeton University '
    orcid: 'https://orcid.org/0000-0002-4475-3181'
abstract: >-
  PegasusTools is an analysis package for use with the
  Pegasus Particle-In-Cell code.
license: MIT

GitHub Events

Total
  • Create event: 84
  • Issues event: 13
  • Release event: 27
  • Delete event: 52
  • Issue comment event: 60
  • Push event: 212
  • Pull request event: 105
  • Fork event: 1
Last Year
  • Create event: 84
  • Issues event: 13
  • Release event: 27
  • Delete event: 52
  • Issue comment event: 60
  • Push event: 212
  • Pull request event: 105
  • Fork event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 8
  • Total pull requests: 65
  • Average time to close issues: 6 days
  • Average time to close pull requests: about 19 hours
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.63
  • Average comments per pull request: 0.52
  • Merged pull requests: 42
  • Bot issues: 0
  • Bot pull requests: 26
Past Year
  • Issues: 8
  • Pull requests: 65
  • Average time to close issues: 6 days
  • Average time to close pull requests: about 19 hours
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.63
  • Average comments per pull request: 0.52
  • Merged pull requests: 42
  • Bot issues: 0
  • Bot pull requests: 26
Top Authors
Issue Authors
  • bcaddy (7)
  • the-mf-zhang (1)
Pull Request Authors
  • bcaddy (39)
  • pre-commit-ci[bot] (13)
  • dependabot[bot] (12)
Top Labels
Issue Labels
Pull Request Labels
dependencies (12) github_actions (12)

Dependencies

.github/workflows/cd.yml actions
  • actions/attest-build-provenance v2.2.3 composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • hynek/build-and-inspect-python-package v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v5.4.0 composite
  • pre-commit/action v3.0.1 composite
pyproject.toml pypi