This is the phono3py module.
Project description
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
.
- Installed by
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
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 phono3py-3.5.1.tar.gz
.
File metadata
- Download URL: phono3py-3.5.1.tar.gz
- Upload date:
- Size: 9.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e194e48502678aa909715265c0e64aa2751938f8b9d087ff03cc5cc840f5667 |
|
MD5 | be5464f791ebd6f22f8eaec5beebaed6 |
|
BLAKE2b-256 | d9380800797faa9e0fa2a2916a7e4df8934ccf21394df76da51d394c8704662e |