Skip to content

Commit

Permalink
deploy: 2fced3a
Browse files Browse the repository at this point in the history
  • Loading branch information
atztogo committed Oct 19, 2023
1 parent 4faf7c1 commit 71394b7
Show file tree
Hide file tree
Showing 74 changed files with 1,139 additions and 14,083 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 10547dcae032bf068a7be3db635d5521
config: 941b29f326e01963e1df49c743ed4f5d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/README.doctree
Binary file not shown.
Binary file modified .doctrees/auxiliary-tools.doctree
Binary file not shown.
Binary file modified .doctrees/changelog.doctree
Binary file not shown.
Binary file modified .doctrees/citation.doctree
Binary file not shown.
Binary file modified .doctrees/command-options.doctree
Binary file not shown.
Binary file modified .doctrees/crystal.doctree
Binary file not shown.
Binary file modified .doctrees/cutoff-pair.doctree
Binary file not shown.
Binary file modified .doctrees/direct-solution.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/examples.doctree
Binary file not shown.
Binary file modified .doctrees/external-tools.doctree
Binary file not shown.
Binary file modified .doctrees/hdf5_howto.doctree
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
Binary file modified .doctrees/input-output-files.doctree
Binary file not shown.
Binary file modified .doctrees/install.doctree
Binary file not shown.
Binary file modified .doctrees/interfaces.doctree
Binary file not shown.
Binary file modified .doctrees/phono3py-api.doctree
Binary file not shown.
Binary file modified .doctrees/phono3py-load.doctree
Binary file not shown.
Binary file modified .doctrees/qe.doctree
Binary file not shown.
Binary file modified .doctrees/reference.doctree
Binary file not shown.
Binary file modified .doctrees/tips.doctree
Binary file not shown.
Binary file modified .doctrees/turbomole.doctree
Binary file not shown.
Binary file modified .doctrees/vasp.doctree
Binary file not shown.
Binary file modified .doctrees/wigner-solution.doctree
Binary file not shown.
Binary file modified .doctrees/workflow.doctree
Binary file not shown.
Binary file modified .doctrees/workload-distribution.doctree
Binary file not shown.
53 changes: 28 additions & 25 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>How to write phono3py documentation &#8212; Phono3py v.2.7.0</title>

Expand All @@ -19,12 +19,12 @@
</script>

<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/theme.css?digest=ac02cc09edc035673794" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=ac02cc09edc035673794" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=ac02cc09edc035673794" rel="stylesheet" />


<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=ac02cc09edc035673794" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
Expand All @@ -33,13 +33,11 @@
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=ac02cc09edc035673794" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
Expand All @@ -57,6 +55,15 @@

<a class="skip-link" href="#main-content">Skip to main content</a>

<div id="pst-scroll-pixel-helper"></div>


<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>
Back to top
</button>


<input type="checkbox"
class="sidebar-toggle"
name="__primary"
Expand Down Expand Up @@ -255,18 +262,18 @@

<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
<button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
</button>
`);
</script>

<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
Expand Down Expand Up @@ -349,16 +356,12 @@ <h2>How to publish<a class="headerlink" href="#how-to-publish" title="Permalink



<footer class="bd-footer-article">

<div class="footer-article-items footer-article__inner">

<div class="footer-article-item"><!-- Previous / next buttons -->


<footer class="prev-next-footer">
<!-- Previous / next buttons -->
<div class="prev-next-area">
</div></div>

</div>

</footer>

</div>
Expand Down Expand Up @@ -419,8 +422,8 @@ <h2>How to publish<a class="headerlink" href="#how-to-publish" title="Permalink
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>
<script src="_static/scripts/bootstrap.js?digest=ac02cc09edc035673794"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794"></script>

<footer class="bd-footer">
</footer>
Expand Down
17 changes: 12 additions & 5 deletions _sources/command-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ created from `FORCES_FC2` and `phono3py_disp.yaml` instead of `FORCES_FC3` and
% phono3py --cfs --dim-fc2="x x x"
```

## Supercell and primitive cell
## Supercell, primitive cell, masses, magnetic moments

(dim_option)=

Expand Down Expand Up @@ -237,6 +237,16 @@ http://phonopy.github.io/phonopy/setting-tags.html#primitive-axis. When a proper
`phono3py_disp.yaml` exists in the current directory, this is unnecessary to be
specified.

### `--mass` (`MASS`)

Atomic masses of **primitive cell** are overwritten. See more details in
[phonopy web page](https://phonopy.github.io/phonopy/setting-tags.html#mass).

### `--magmom` (`MAGMOM`)

Magnetic moments of **unit cell** are specified. This information is used to find crystal symmetry. See more details in [phonopy
web page](https://phonopy.github.io/phonopy/setting-tags.html#magmom).

## Displacement creation

(create_displacements_option)=
Expand Down Expand Up @@ -627,7 +637,6 @@ option works only when `--br` options are activated. Therefore third-order force
constants are not necessary to input. The physical unit of the value is
$\text{eV}^2$. See also references {cite}`Togo-PRB-2015,Mizokami-PRB-2018`.


```bash
% phono3py --dim="3 3 2" -v --mesh="32 32 20" -c POSCAR-unitcell --br --const-ave-pp=1e-10
```
Expand Down Expand Up @@ -908,12 +917,10 @@ file, where $A_{\mathrm{q}j}$ is normalied as given above, i.e., numerical
sum of stored value for each band should become roughly 1.
```


(jdos_option)=

## Joint density of states (JDOS) and weighted-JDOS


### `--jdos` (`JOINT_DOS = .TRUE.`)

Two classes of joint density of states (JDOS) are calculated. The result is
Expand Down Expand Up @@ -1240,8 +1247,8 @@ This modifies default input and output file names.

This is equivalent to setting `-i` and `-o` simultaneously.


## References

```{bibliography}
:filter: docname in docnames
```
134 changes: 0 additions & 134 deletions _static/_sphinx_javascript_frameworks_compat.js

This file was deleted.

Loading

0 comments on commit 71394b7

Please sign in to comment.