Skip to main content

This is the phono3py module.

Project description

Version Badge Downloads Badge PyPI version PyPI codecov

phono3py

A simulation package of phonon-phonon interaction related properties mainly written in python. Phono3py user documentation is found at http://phonopy.github.io/phono3py/.

Mailing list for questions

Usual phono3py questions should be sent to phonopy mailing list (https://sourceforge.net/p/phonopy/mailman/).

Dependency

See requirements.txt. Optionally symfc and scipy are required for using additional features.

Development

The development of phono3py is managed on the develop branch of github phono3py repository.

  • Github issues is the place to discuss about phono3py issues.

  • Github pull request is the place to request merging source code.

  • Formatting rules are found in pyproject.toml.

  • Not strictly, but VSCode's settings.json may be written like below

    "ruff.lint.args": [
        "--config=${workspaceFolder}/pyproject.toml",
    ],
    "[python]": {
        "editor.defaultFormatter": "charliermarsh.ruff",
        "editor.codeActionsOnSave": {
            "source.organizeImports": "explicit"
        }
    },
    
  • Use of pre-commit (https://pre-commit.com/) is encouraged.

    • Installed by pip install pre-commit, conda install pre_commit or see https://pre-commit.com/#install.
    • pre-commit hook is installed by pre-commit install.
    • pre-commit hook is run by pre-commit run --all-files.

Documentation

Phono3py user documentation is written using python sphinx. The source files are stored in doc directory. Please see how to write the documentation at doc/README.md.

How to run tests

Tests are written using pytest. To run tests, pytest has to be installed. The tests can be run by

% pytest

Project details


Release history Release notifications | RSS feed

This version

3.6.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

phono3py-3.6.0.tar.gz (9.3 MB view details)

Uploaded Source

File details

Details for the file phono3py-3.6.0.tar.gz.

File metadata

  • Download URL: phono3py-3.6.0.tar.gz
  • Upload date:
  • Size: 9.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for phono3py-3.6.0.tar.gz
Algorithm Hash digest
SHA256 6d2dcf8438f9049fe15973715fa2d35085f646bc26657b2256429a20a97bf922
MD5 a9f14a40af711791e9eac9e2abcb8ff1
BLAKE2b-256 dfc598af644f2d4636f584e52a0f90e583a549950aa4eea86dc1d4a68b4a0e71

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page