idaholab/montepy

0

/ 100

Documentation92
Engineering76
Health100
Python64MIT1d ago
Grade a repo

Well engineered for its size. A portfolio piece worth showing off.

MontePy is the most user friendly Python library (API) to read, edit, and write MCNP input files.

Documentation

92

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

76

Linting and formatting5pt0

No linter or formatter configured.

→ Add [tool.ruff] to pyproject.toml. Ruff handles linting and formatting in one tool and replaces flake8, isort, and black.

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

CI/CD14pt85

CI is configured (.github/workflows/main.yml).

Tests18pt100

Test files detected (doc/source/tests).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 22
    Forks
  • 41
    Releaseslatest 2y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 64
    Watchers

Responsiveness

  • 3d 3h
    Median issue response
  • 3d 20h
    Median PR merge time
  • 108
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
    Good: Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • benchmark
  • demo
  • doc
    Good: Test files detected (doc/source/tests).
  • graphics
  • montepy
  • prof
  • tests
  • .git_archival.txt
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .readthedocs.yaml
  • AUTHORS
  • CHANGELOG.rst
  • CITATION.cff
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • LICENSE
    Good: Licensed under MIT.
  • MANIFEST.in
  • NOTICE.txt
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.