Skip to content

Commit

Permalink
v1.0.0 commit including the tp logo, slightly updated docs and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
@kbspooner
kbspooner committed Feb 4, 2021
1 parent bf731b8 commit efe82b1
Show file tree
Hide file tree
Showing 68 changed files with 221 additions and 100 deletions.
11 changes: 10 additions & 1 deletion README.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
.. image:: https://travis-ci.com/SMTG-UCL/ThermoPlotter.svg?branch=master
:target: https://travis-ci.com/SMTG-UCL/ThermoPlotter

.. image:: figures/tp-logo.png
:target: https://smtg-ucl.github.io/ThermoPlotter/

.. code-block::
________
Expand All @@ -11,7 +14,7 @@
| | |__ __ |___ |_____ __ :|___/ | ___ __|__ __|__ __ |__ \
| | | | / \ | \ | | | / \:| | / \ | | / \ | \ /
| | | | |__/ | | | | | |:| | | | | | |__/ | \_____
| | | | \__ | | | | \__/:| \__ \___/ \__ \__ \__ | :0.4.1\
| | | | \__ | | | | \__/:| \__ \___/ \__ \__ \__ | :1.0.0\
|_________________________________:______________________________________:_____/
Expand Down Expand Up @@ -127,6 +130,12 @@ appreciated.
.. _documentation: https://smtg-ucl.github.io/ThermoPlotter/
.. _tests: https://github.com/smtg-ucl/ThermoPlotter/tree/master/tests

Documentation
-------------

Documentation uses the `sphinx`_ package, and can be built from the docs
directory with ``sphinx-build -b html src/ .``.

Testing
-------

Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
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: 5e3cdf555563bd7a40310fc8217bbeaf
config: bf98ff1b5ef37c602d8d04e53c525297
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/tp.plot.doctree
View file
Binary file not shown.
Binary file modified docs/_images/kappa-target.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/multiphon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/phonons.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/prophon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/tp-logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/waterfall.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/ztmap.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Overview: module code &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>Overview: module code &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -185,7 +189,7 @@ <h1>All modules for which code is available</h1>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/axes/four.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.axes.four &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.axes.four &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -223,7 +227,7 @@ <h1>Source code for tp.axes.four</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/axes/one.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.axes.one &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.axes.one &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -688,7 +692,7 @@ <h1>Source code for tp.axes.one</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/axes/three.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.axes.three &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.axes.three &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -648,7 +652,7 @@ <h1>Source code for tp.axes.three</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/axes/two.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.axes.two &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.axes.two &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -385,7 +389,7 @@ <h1>Source code for tp.axes.two</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/calculate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.calculate &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.calculate &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -459,7 +463,7 @@ <h1>Source code for tp.calculate</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/data/aniso.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.data.aniso &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.data.aniso &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -425,7 +429,7 @@ <h1>Source code for tp.data.aniso</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/data/load.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.data.load &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.data.load &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -780,7 +784,7 @@ <h1>Source code for tp.data.load</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/data/resolve.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.data.resolve &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.data.resolve &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -269,7 +273,7 @@ <h1>Source code for tp.data.resolve</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
8 changes: 6 additions & 2 deletions docs/_modules/tp/data/run.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>tp.data.run &mdash; ThermoPlotter 0.3.1 documentation</title>
<title>tp.data.run &mdash; ThermoPlotter 1.0.0 documentation</title>



Expand Down Expand Up @@ -56,6 +56,9 @@




<img src="../../../_static/tp-logo.png" class="logo" alt="Logo"/>

</a>


Expand Down Expand Up @@ -88,6 +91,7 @@
<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#usage">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#id2">Documentation</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>
Expand Down Expand Up @@ -424,7 +428,7 @@ <h1>Source code for tp.data.run</h1><div class="highlight"><pre>

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

</p>
</div>
Expand Down
Loading

0 comments on commit efe82b1

Please sign in to comment.