Skip to content

Commit

Permalink
Update links in documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@tanner-trickle
tanner-trickle committed Oct 25, 2022
1 parent f4302c5 commit 6093657
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 17 deletions.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/doctrees/pages/data.doctree
View file
Binary file not shown.
10 changes: 5 additions & 5 deletions docs/html/_sources/pages/data.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ While the :code:`examples` folder contains many example electronic configuration
Si
**

- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Si/scatter/Si_scatter_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for binned scattering rate and dielectric calculations.
Expand All @@ -38,7 +38,7 @@ Si
- 40000 states (:math:`10 \times 10 \times 400` grid in :math:`(\theta, \phi, p)` space). Uniformly sampled on the sphere in :math:`(\theta, \phi)`, logarithmically sampled in :math:`E = p^2/2m_e` between :math:`E_\text{min} = 60 \, \text{eV}` and :math:`E_\text{max} = 400 \, \text{eV}`.


- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Si/abs/Si_abs_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for absorption rate calculations.
Expand All @@ -62,7 +62,7 @@ Si
Ge
**

- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Ge/scatter/Ge_scatter_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for binned scattering rate and dielectric calculations.
Expand All @@ -82,7 +82,7 @@ Ge
- **single PW basis**
- 40000 states (:math:`10 \times 10 \times 400` grid in :math:`(\theta, \phi, p)` space). Uniformly sampled on the sphere in :math:`(\theta, \phi)`, logarithmically sampled in :math:`E = p^2/2m_e` between :math:`E_\text{min} = 60 \, \text{eV}` and :math:`E_\text{max} = 400 \, \text{eV}`.

- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Ge/abs/Ge_abs_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for absorption rate calculations.
Expand Down Expand Up @@ -112,7 +112,7 @@ EXCEED-DMv1.0.0: Extended Calculation of Electronic Excitations for Direct Detec
***************************************************************************************************

- Ref: (add arXiv link when available)
- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7250090#.Y1g4J7aSnZc
- Description:
Output of all the calculations performed in the :code:`v1.0.0` user manual. Specifically, for Si and Ge targets,
- Numerically computed dielectric (to be used to screen the scattering rate calculation).
Expand Down
2 changes: 1 addition & 1 deletion docs/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ <h2>Features<a class="headerlink" href="#features" title="Permalink to this head
</section>
<section id="attribution">
<h2>Attribution<a class="headerlink" href="#attribution" title="Permalink to this heading">#</a></h2>
<p>If you use <code class="code docutils literal notranslate"><span class="pre">EXCEED-DM</span></code> in your work, please cite: <span id="id1">[<a class="reference internal" href="#id7" title="Sinéad M. Griffin, Katherine Inzani, Tanner Trickle, Zhengkang Zhang, and Kathryn M. Zurek. Extended calculation of dark matter-electron scattering in crystal targets. Phys. Rev. D, 104(9):095015, 5 2021. arXiv:2105.05253, doi:10.1103/PhysRevD.104.095015.">1</a>, <a class="reference internal" href="#id9" title="Tanner Trickle and Kinzani. Tanner-trickle/exceed-dm: exceed-dm-v0.3.0. 2022. URL: https://zenodo.org/record/6097642, doi:10.5281/ZENODO.6097642.">2</a>]</span></p>
<p>If you use <code class="code docutils literal notranslate"><span class="pre">EXCEED-DM</span></code> in your work, please cite: <span id="id1">[<a class="reference internal" href="pages/data.html#id17" title="Sinéad M. Griffin, Katherine Inzani, Tanner Trickle, Zhengkang Zhang, and Kathryn M. Zurek. Extended calculation of dark matter-electron scattering in crystal targets. Phys. Rev. D, 104(9):095015, 5 2021. arXiv:2105.05253, doi:10.1103/PhysRevD.104.095015.">1</a>, <a class="reference internal" href="pages/data.html#id19" title="Tanner Trickle and Kinzani. Tanner-trickle/exceed-dm: exceed-dm-v0.3.0. 2022. URL: https://zenodo.org/record/6097642, doi:10.5281/ZENODO.6097642.">2</a>]</span></p>
<div class="docutils container" id="id2">
<div class="citation" id="id7" role="doc-biblioentry">
<span class="label"><span class="fn-bracket">[</span><a href="#id1" role="doc-backlink">1</a><span class="fn-bracket">]</span></span>
Expand Down
10 changes: 5 additions & 5 deletions docs/html/pages/data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ <h2>Electronic Configuration Files<a class="headerlink" href="#electronic-config
<h3>Si<a class="headerlink" href="#si" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><dl class="simple">
<dt>Link: (add Zenodo link when available)</dt><dd><ul>
<dt>Link: <a class="reference external" href="https://zenodo.org/record/7246141#.Y1g31raSnZc">https://zenodo.org/record/7246141#.Y1g31raSnZc</a></dt><dd><ul>
<li><p>File: <code class="code docutils literal notranslate"><span class="pre">Si/scatter/Si_scatter_elec_config.hdf5</span></code></p></li>
<li><dl class="simple">
<dt>Description:</dt><dd><ul>
Expand Down Expand Up @@ -276,7 +276,7 @@ <h3>Si<a class="headerlink" href="#si" title="Permalink to this heading">#</a></
</dl>
</li>
<li><dl class="simple">
<dt>Link: (add Zenodo link when available)</dt><dd><ul>
<dt>Link: <a class="reference external" href="https://zenodo.org/record/7246141#.Y1g31raSnZc">https://zenodo.org/record/7246141#.Y1g31raSnZc</a></dt><dd><ul>
<li><p>File: <code class="code docutils literal notranslate"><span class="pre">Si/abs/Si_abs_elec_config.hdf5</span></code></p></li>
<li><dl class="simple">
<dt>Description:</dt><dd><ul>
Expand Down Expand Up @@ -338,7 +338,7 @@ <h3>Si<a class="headerlink" href="#si" title="Permalink to this heading">#</a></
<h3>Ge<a class="headerlink" href="#ge" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><dl class="simple">
<dt>Link: (add Zenodo link when available)</dt><dd><ul>
<dt>Link: <a class="reference external" href="https://zenodo.org/record/7246141#.Y1g31raSnZc">https://zenodo.org/record/7246141#.Y1g31raSnZc</a></dt><dd><ul>
<li><p>File: <code class="code docutils literal notranslate"><span class="pre">Ge/scatter/Ge_scatter_elec_config.hdf5</span></code></p></li>
<li><dl class="simple">
<dt>Description:</dt><dd><ul>
Expand Down Expand Up @@ -395,7 +395,7 @@ <h3>Ge<a class="headerlink" href="#ge" title="Permalink to this heading">#</a></
</dl>
</li>
<li><dl class="simple">
<dt>Link: (add Zenodo link when available)</dt><dd><ul>
<dt>Link: <a class="reference external" href="https://zenodo.org/record/7246141#.Y1g31raSnZc">https://zenodo.org/record/7246141#.Y1g31raSnZc</a></dt><dd><ul>
<li><p>File: <code class="code docutils literal notranslate"><span class="pre">Ge/abs/Ge_abs_elec_config.hdf5</span></code></p></li>
<li><dl class="simple">
<dt>Description:</dt><dd><ul>
Expand Down Expand Up @@ -463,7 +463,7 @@ <h3>EXCEED-DMv1.0.0: Extended Calculation of Electronic Excitations for Direct D
<ul class="simple">
<li><dl class="simple">
<dt>Ref: (add arXiv link when available)</dt><dd><ul>
<li><p>Link: (add Zenodo link when available)</p></li>
<li><p>Link: <a class="reference external" href="https://zenodo.org/record/7250090#.Y1g4J7aSnZc">https://zenodo.org/record/7250090#.Y1g4J7aSnZc</a></p></li>
<li><dl class="simple">
<dt>Description:</dt><dd><dl class="simple">
<dt>Output of all the calculations performed in the <code class="code docutils literal notranslate"><span class="pre">v1.0.0</span></code> user manual. Specifically, for Si and Ge targets,</dt><dd><ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/pages/data.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ While the :code:`examples` folder contains many example electronic configuration
Si
**

- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Si/scatter/Si_scatter_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for binned scattering rate and dielectric calculations.
Expand All @@ -38,7 +38,7 @@ Si
- 40000 states (:math:`10 \times 10 \times 400` grid in :math:`(\theta, \phi, p)` space). Uniformly sampled on the sphere in :math:`(\theta, \phi)`, logarithmically sampled in :math:`E = p^2/2m_e` between :math:`E_\text{min} = 60 \, \text{eV}` and :math:`E_\text{max} = 400 \, \text{eV}`.


- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Si/abs/Si_abs_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for absorption rate calculations.
Expand All @@ -62,7 +62,7 @@ Si
Ge
**

- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Ge/scatter/Ge_scatter_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for binned scattering rate and dielectric calculations.
Expand All @@ -82,7 +82,7 @@ Ge
- **single PW basis**
- 40000 states (:math:`10 \times 10 \times 400` grid in :math:`(\theta, \phi, p)` space). Uniformly sampled on the sphere in :math:`(\theta, \phi)`, logarithmically sampled in :math:`E = p^2/2m_e` between :math:`E_\text{min} = 60 \, \text{eV}` and :math:`E_\text{max} = 400 \, \text{eV}`.

- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7246141#.Y1g31raSnZc
- File: :code:`Ge/abs/Ge_abs_elec_config.hdf5`
- Description:
- Electronic states assumed to be spin-degenerate, i.e., one-component wave functions. Used for absorption rate calculations.
Expand Down Expand Up @@ -112,7 +112,7 @@ EXCEED-DMv1.0.0: Extended Calculation of Electronic Excitations for Direct Detec
***************************************************************************************************

- Ref: (add arXiv link when available)
- Link: (add Zenodo link when available)
- Link: https://zenodo.org/record/7250090#.Y1g4J7aSnZc
- Description:
Output of all the calculations performed in the :code:`v1.0.0` user manual. Specifically, for Si and Ge targets,
- Numerically computed dielectric (to be used to screen the scattering rate calculation).
Expand Down

0 comments on commit 6093657

Please sign in to comment.