phono3py 3.1.2__tar.gz → 3.2.0__tar.gz

{phono3py-3.1.2/phono3py.egg-info → phono3py-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: phono3py
-Version: 3.1.2
+Version: 3.2.0
 Summary: This is the phono3py module.
 Home-page: http://phonopy.github.io/phono3py/
 Author: Atsushi Togo
@@ -14,4 +14,4 @@ Requires-Dist: PyYAML>=5.3
 Requires-Dist: matplotlib>=2.2.2
 Requires-Dist: h5py>=3.0
 Requires-Dist: spglib>=2.0
-Requires-Dist: phonopy<2.25,>=2.24
+Requires-Dist: phonopy<2.26,>=2.25

{phono3py-3.1.2 → phono3py-3.2.0}/README.md

@@ -6,14 +6,20 @@
 
 # phono3py
 
-A simulation package of phonon-phonon interaction related properties. Phono3py
-user documentation is found at http://phonopy.github.io/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
@@ -21,26 +27,19 @@ phono3py repository.
 
 - Github issues is the place to discuss about phono3py issues.
 - Github pull request is the place to request merging source code.
-- Python 3.7 is the minimum requirement.
-- Formatting is written in `pyproject.toml`.
-- Not strictly, but VSCode's `settings.json` may be written like
+- Formatting rules are found in `pyproject.toml`.
+- Not strictly, but VSCode's `settings.json` may be written like below
 
   ```json
-  "python.linting.flake8Enabled": true,
-  "python.linting.flake8Args": ["--max-line-length=88", "--ignore=E203,W503"],
-  "python.linting.enabled": true,
-  "python.linting.pylintEnabled": false,
-  "python.linting.mypyEnabled": true,
-  "python.linting.pycodestyleEnabled": false,
-  "python.linting.pydocstyleEnabled": true,
-  "python.formatting.provider": "black",
-  "python.formatting.blackArgs": ["--line-length=88"],
-  "python.sortImports.args": ["--profile", "black"],
+  "ruff.lint.args": [
+      "--config=${workspaceFolder}/pyproject.toml",
+  ],
   "[python]": {
+      "editor.defaultFormatter": "charliermarsh.ruff",
       "editor.codeActionsOnSave": {
-      "source.organizeImports": true
-    },
-  }
+          "source.organizeImports": "explicit"
+      }
+  },
   ```
 
 - Use of pre-commit (https://pre-commit.com/) is encouraged.
@@ -57,7 +56,8 @@ stored in `doc` directory. Please see how to write the documentation at
 
 ## How to run tests
 
-You need pytest. At home directory of phono3py after setup,
+Tests are written using pytest. To run tests, pytest has to be installed. The
+tests can be run by
 
 ```bash
 % pytest

phono3py-3.2.0/__nanoversion__.txt

@@ -0,0 +1 @@
+3.2.0