Skip to content

Commit

Permalink
Deployed 58fc491 to latest with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@bot-optimade
bot-optimade committed Oct 15, 2024
1 parent 2d9768e commit 6abbb02
Show file tree
Hide file tree
Showing 51 changed files with 2,373 additions and 2,554 deletions.
25 changes: 25 additions & 0 deletions latest/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,15 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#unreleased-changes-2024-10-15" class="md-nav__link">
<span class="md-ellipsis">
Unreleased changes (2024-10-15)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#v115-2024-10-15" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -3491,6 +3500,15 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#unreleased-changes-2024-10-15" class="md-nav__link">
<span class="md-ellipsis">
Unreleased changes (2024-10-15)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#v115-2024-10-15" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -4425,6 +4443,13 @@


<h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">&para;</a></h1>
<h2 id="unreleased-changes-2024-10-15"><a href="https://github.com/Materials-Consortia/optimade-python-tools/tree/Unreleased changes">Unreleased changes</a> (2024-10-15)<a class="headerlink" href="#unreleased-changes-2024-10-15" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.1.5...Unreleased changes">Full Changelog</a></p>
<p><strong>Merged pull requests:</strong></p>
<ul>
<li>Update README with pre-emptive support of OPTIMADE versions <a href="https://github.com/Materials-Consortia/optimade-python-tools/pull/2165">#2165</a> (<a href="https://github.com/ml-evs">ml-evs</a>)</li>
<li>Remove support for Python 3.9 <a href="https://github.com/Materials-Consortia/optimade-python-tools/pull/2158">#2158</a> (<a href="https://github.com/ml-evs">ml-evs</a>)</li>
</ul>
<h2 id="v115-2024-10-15"><a href="https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.1.5">v1.1.5</a> (2024-10-15)<a class="headerlink" href="#v115-2024-10-15" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.1.4...v1.1.5">Full Changelog</a></p>
<p><strong>Closed issues:</strong></p>
Expand Down
2,263 changes: 1,077 additions & 1,186 deletions latest/all_models/index.html
View file

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions latest/api_reference/adapters/base/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2893,8 +2893,7 @@ <h2 id="optimade.adapters.base.EntryAdapter" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>optimade/adapters/base.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 31</span>
<span class="normal"> 32</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 32</span>
<span class="normal"> 33</span>
<span class="normal"> 34</span>
<span class="normal"> 35</span>
Expand Down Expand Up @@ -3115,7 +3114,8 @@ <h2 id="optimade.adapters.base.EntryAdapter" class="doc doc-heading">
<span class="normal">250</span>
<span class="normal">251</span>
<span class="normal">252</span>
<span class="normal">253</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">EntryAdapter</span><span class="p">:</span>
<span class="normal">253</span>
<span class="normal">254</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">EntryAdapter</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Base class for lazy resource entry adapters.</span>

Expand Down Expand Up @@ -3193,7 +3193,7 @@ <h2 id="optimade.adapters.base.EntryAdapter" class="doc doc-heading">
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_converted</span><span class="p">[</span><span class="nb">format</span><span class="p">]</span>

<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">ingest_from</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">ingest_from</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert desired format to OPTIMADE format.</span>

<span class="sd"> Parameters:</span>
Expand Down Expand Up @@ -3269,7 +3269,7 @@ <h2 id="optimade.adapters.base.EntryAdapter" class="doc doc-heading">

<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_get_model_attributes</span><span class="p">(</span>
<span class="n">starting_instances</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="n">BaseModel</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span> <span class="nb">list</span><span class="p">[</span><span class="n">BaseModel</span><span class="p">]],</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">starting_instances</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">BaseModel</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">BaseModel</span><span class="p">],</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Helper method for retrieving the OPTIMADE model&#39;s attribute, supporting &quot;.&quot;-nested attributes&quot;&quot;&quot;</span>
<span class="k">for</span> <span class="n">res</span> <span class="ow">in</span> <span class="n">starting_instances</span><span class="p">:</span>
Expand Down Expand Up @@ -3483,8 +3483,7 @@ <h3 id="optimade.adapters.base.EntryAdapter.__getattr__" class="doc doc-heading"

<details class="quote">
<summary>Source code in <code>optimade/adapters/base.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">200</span>
<span class="normal">201</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">201</span>
<span class="normal">202</span>
<span class="normal">203</span>
<span class="normal">204</span>
Expand Down Expand Up @@ -3536,7 +3535,8 @@ <h3 id="optimade.adapters.base.EntryAdapter.__getattr__" class="doc doc-heading"
<span class="normal">250</span>
<span class="normal">251</span>
<span class="normal">252</span>
<span class="normal">253</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="normal">253</span>
<span class="normal">254</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get converted entry or attribute from OPTIMADE entry.</span>

<span class="sd"> Support any level of &quot;.&quot;-nested OPTIMADE `ENTRY_RESOURCE` attributes, e.g.,</span>
Expand Down Expand Up @@ -3641,8 +3641,7 @@ <h3 id="optimade.adapters.base.EntryAdapter.__init__" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>optimade/adapters/base.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">51</span>
<span class="normal">52</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">52</span>
<span class="normal">53</span>
<span class="normal">54</span>
<span class="normal">55</span>
Expand All @@ -3656,7 +3655,8 @@ <h3 id="optimade.adapters.base.EntryAdapter.__init__" class="doc doc-heading">
<span class="normal">63</span>
<span class="normal">64</span>
<span class="normal">65</span>
<span class="normal">66</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="normal">66</span>
<span class="normal">67</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Parameters:</span>
<span class="sd"> entry (dict): A JSON OPTIMADE single resource entry.</span>
Expand Down Expand Up @@ -3770,8 +3770,7 @@ <h3 id="optimade.adapters.base.EntryAdapter.convert" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>optimade/adapters/base.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 78</span>
<span class="normal"> 79</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 79</span>
<span class="normal"> 80</span>
<span class="normal"> 81</span>
<span class="normal"> 82</span>
Expand All @@ -3798,7 +3797,8 @@ <h3 id="optimade.adapters.base.EntryAdapter.convert" class="doc doc-heading">
<span class="normal">103</span>
<span class="normal">104</span>
<span class="normal">105</span>
<span class="normal">106</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="normal">106</span>
<span class="normal">107</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert OPTIMADE entry to desired format.</span>

<span class="sd"> Parameters:</span>
Expand Down Expand Up @@ -3906,8 +3906,7 @@ <h3 id="optimade.adapters.base.EntryAdapter.from_url" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>optimade/adapters/base.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">150</span>
<span class="normal">151</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">151</span>
<span class="normal">152</span>
<span class="normal">153</span>
<span class="normal">154</span>
Expand Down Expand Up @@ -3937,7 +3936,8 @@ <h3 id="optimade.adapters.base.EntryAdapter.from_url" class="doc doc-heading">
<span class="normal">178</span>
<span class="normal">179</span>
<span class="normal">180</span>
<span class="normal">181</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@classmethod</span>
<span class="normal">181</span>
<span class="normal">182</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_url</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">url</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert OPTIMADE URL into the target entry type.</span>

Expand Down Expand Up @@ -4087,8 +4087,7 @@ <h3 id="optimade.adapters.base.EntryAdapter.ingest_from" class="doc doc-heading"

<details class="quote">
<summary>Source code in <code>optimade/adapters/base.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">108</span>
<span class="normal">109</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">109</span>
<span class="normal">110</span>
<span class="normal">111</span>
<span class="normal">112</span>
Expand Down Expand Up @@ -4127,8 +4126,9 @@ <h3 id="optimade.adapters.base.EntryAdapter.ingest_from" class="doc doc-heading"
<span class="normal">145</span>
<span class="normal">146</span>
<span class="normal">147</span>
<span class="normal">148</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">ingest_from</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="normal">148</span>
<span class="normal">149</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">ingest_from</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert desired format to OPTIMADE format.</span>

<span class="sd"> Parameters:</span>
Expand Down
Loading

0 comments on commit 6abbb02

Please sign in to comment.