This is the phonopy module.
Project description
Phonopy
Phonon code mainly written in python. Phonopy user documentation is found at http://phonopy.github.io/phonopy/
Installation
See https://phonopy.github.io/phonopy/install.html.
Dependency
See requirements.txt. Optionally symfc, scipy and seekpath are required
for using additional features.
Mailing list for questions
Usual phonopy questions should be sent to phonopy mailing list (https://sourceforge.net/p/phonopy/mailman/).
Development
The development of phonopy is managed on the develop branch of github phonopy
repository.
- Github issues is the place to discuss about phonopy issues.
- Github pull request is the place to request merging source code.
Formatting
Formatting rules are found in pyproject.toml.
pre-commit
Pre-commit (https://pre-commit.com/) is mainly used for applying the formatting rules automatically. Therefore, it is strongly encouraged to use it at or before git-commit. Pre-commit is set-up and used in the following way:
- Installed by
pip install pre-commit,conda install pre_commitor 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.
Unless running pre-commit, pre-commit.ci may push the fix at PR by github action. In this case, the fix should be merged by the contributor's repository.
VSCode setting
-
Not strictly, but VSCode's
settings.jsonmay be written like below"ruff.lint.args": [ "--config=${workspaceFolder}/pyproject.toml", ], "[python]": { "editor.defaultFormatter": "charliermarsh.ruff", "editor.codeActionsOnSave": { "source.organizeImports": "explicit" } },
Documentation
Phonopy 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file phonopy-2.26.5.tar.gz.
File metadata
- Download URL: phonopy-2.26.5.tar.gz
- Upload date:
- Size: 4.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f4387d954eb661a8e189c53ee3d91b01734f473d9a6b95d34176c2a530edd68 |
|
| MD5 | fbd6b01f72bd7e3e71abbceb88882fb0 |
|
| BLAKE2b-256 | 365c1926a7d45e15fd6fd4f87f26b430d6e651580b628cc2936cd80181b28a48 |
