Skip to content

Commit

Permalink
Merge pull request #47 from SMTG-UCL/master
Browse files Browse the repository at this point in the history
update to newest version
  • Loading branch information
kbspooner authored Oct 26, 2022
2 parents 791133e + 751305d commit 3fb875b
Show file tree
Hide file tree
Showing 37 changed files with 282 additions and 61 deletions.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/tp.doctree
Binary file not shown.
Binary file modified docs/.doctrees/tp.plot.doctree
Binary file not shown.
3 changes: 2 additions & 1 deletion docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="tp.html">tp</a></li>
<ul><li><a href="tp/axes/large.html">tp.axes.large</a></li>
<li><a href="tp/axes/legend.html">tp.axes.legend</a></li>
<li><a href="tp/axes/small.html">tp.axes.small</a></li>
Expand All @@ -89,7 +90,7 @@ <h1>All modules for which code is available</h1>
<li><a href="tp/plot/utilities.html">tp.plot.utilities</a></li>
<li><a href="tp/settings.html">tp.settings</a></li>
<li><a href="tp/setup/vasp.html">tp.setup.vasp</a></li>
</ul>
</ul></ul>

</div>
</div>
Expand Down
123 changes: 123 additions & 0 deletions docs/_modules/tp.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tp &mdash; ThermoPlotter 2.0.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html" class="icon icon-home"> ThermoPlotter<img src="../_static/tp-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../gallery.html">Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#command-line-usage">Command Line Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#python-usage">Python Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#contributing">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#testing">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#contributors">Contributors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#license">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#requirements">Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="../modules.html">Python Package</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">ThermoPlotter</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="index.html">Module code</a> &raquo;</li>
<li>tp</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for tp</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Everything.</span>

<span class="sd">Modules</span>
<span class="sd">-------</span>

<span class="sd"> calculate</span>
<span class="sd"> tools for calculating derived properties and interpolating</span>
<span class="sd"> settings</span>
<span class="sd"> default values and metadata</span>
<span class="sd">&quot;&quot;&quot;</span>

<div class="viewcode-block" id="docstring_replace"><a class="viewcode-back" href="../tp.html#tp.docstring_replace">[docs]</a><span class="k">def</span> <span class="nf">docstring_replace</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">d</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
<span class="n">f</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="vm">__doc__</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">f</span>
<span class="k">return</span> <span class="n">d</span></div>

<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">settings</span> <span class="c1"># required for other imports, prevents circularity</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">axes</span><span class="p">,</span> <span class="n">calculate</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">plot</span><span class="p">,</span> <span class="n">setup</span><span class="p">,</span> <span class="n">cli</span>
</pre></div>

</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2021, Scanlon Materials Theory Group.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
1 change: 1 addition & 0 deletions docs/_modules/tp/axes/large.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.axes.large</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
14 changes: 9 additions & 5 deletions docs/_modules/tp/axes/legend.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.axes.legend</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down Expand Up @@ -164,16 +165,19 @@ <h1>Source code for tp.axes.legend</h1><div class="highlight"><pre>

<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">location</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">)):</span>
<span class="n">location</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">location</span><span class="p">)</span>
<span class="n">incol</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="s1">&#39;ncol&#39;</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">locations</span><span class="p">:</span>
<span class="n">l</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span>
<span class="n">incol</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span>
<span class="k">del</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span>

<span class="n">fin</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">custom</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">a</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">ax</span><span class="p">):</span>
<span class="k">if</span> <span class="n">a</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">location</span> <span class="ow">in</span> <span class="n">names</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="n">legend</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">&#39;best&#39;</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">legend</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">&#39;best&#39;</span><span class="p">,</span> <span class="n">ncol</span><span class="o">=</span><span class="n">incol</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">fin</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">break</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">fin</span><span class="p">:</span>
Expand All @@ -191,8 +195,7 @@ <h1>Source code for tp.axes.legend</h1><div class="highlight"><pre>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">a</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">ax</span><span class="p">):</span>
<span class="k">if</span> <span class="n">a</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">location</span> <span class="ow">in</span> <span class="n">names</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="n">legend</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">&#39;best&#39;</span><span class="p">,</span> <span class="n">handles</span><span class="o">=</span><span class="n">handles</span><span class="p">,</span>
<span class="n">labels</span><span class="o">=</span><span class="n">labels</span><span class="p">,</span>
<span class="n">ncol</span><span class="o">=</span><span class="n">locations</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="s1">&#39;ncol&#39;</span><span class="p">],</span>
<span class="n">labels</span><span class="o">=</span><span class="n">labels</span><span class="p">,</span> <span class="n">ncol</span><span class="o">=</span><span class="n">incol</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">fin</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">break</span>
Expand Down Expand Up @@ -222,16 +225,17 @@ <h1>Source code for tp.axes.legend</h1><div class="highlight"><pre>

<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">location</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">)):</span>
<span class="n">location</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">location</span><span class="p">)</span>
<span class="n">incol</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="s1">&#39;ncol&#39;</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">locations</span><span class="p">:</span>
<span class="n">l</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span>
<span class="n">incol</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span>
<span class="k">del</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;ncol&#39;</span><span class="p">]</span>

<span class="n">fin</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">a</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">ax</span><span class="p">):</span>
<span class="k">if</span> <span class="n">location</span> <span class="ow">in</span> <span class="n">names</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="n">legend</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">&#39;best&#39;</span><span class="p">,</span> <span class="n">ncol</span><span class="o">=</span><span class="n">locations</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="s1">&#39;ncol&#39;</span><span class="p">],</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">legend</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">&#39;best&#39;</span><span class="p">,</span> <span class="n">ncol</span><span class="o">=</span><span class="n">incol</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">fin</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">break</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">fin</span><span class="p">:</span>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/axes/small.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.axes.small</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/calculate.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
<li><a href="../tp.html">tp</a> &raquo;</li>
<li>tp.calculate</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/cli/options.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.cli.options</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/data/load.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.data.load</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/data/resolve.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.data.resolve</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/data/run.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.data.run</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/data/save.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.data.save</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/data/utilities.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.data.utilities</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/_modules/tp/plot/colour.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../../../contents.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../../tp.html">tp</a> &raquo;</li>
<li>tp.plot.colour</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand Down
Loading

0 comments on commit 3fb875b

Please sign in to comment.