Skip to content

Commit

Permalink
Add badges for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ElliottKasoar committed Feb 6, 2025
1 parent 7e1c8ce commit 77ab91d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,13 +219,13 @@ print(results)

will read the NaCl structure file and attach the MACE-MP (medium) calculator, before calculating and printing the energy, forces, and stress.

Jupyter Notebook tutorials illustrating the use of currently available calculations can be found in the [janus-tutorials](https://github.com/stfc/janus-tutorials) repository. This currently includes examples for:
Jupyter Notebook tutorials illustrating the use of currently available calculations can be found in the [tutorials](https://github.com/stfc/janus-core/tree/main/docs/source/tutorials) documentation directory. This currently includes examples for:

- [Single Point](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/single_point.ipynb)
- [Geometry Optimization](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/geom_opt.ipynb)
- [Molecular Dynamics](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/md.ipynb)
- [Equation of State](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/eos.ipynb)
- [Phonons](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/phonons.ipynb)
- [Single Point](docs/source/tutorials/single_point.ipynb) [![badge](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/single_point.ipynb)
- [Geometry Optimization](docs/source/tutorials/geom_opt.ipynb) [![badge](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/geom_opt.ipynb)
- [Molecular Dynamics](docs/source/tutorials/md.ipynb) [![badge](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/md.ipynb)
- [Equation of State](docs/source/tutorials/eos.ipynb) [![badge](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/eos.ipynb)
- [Phonons](docs/source/tutorials/phonons.ipynb) [![badge](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/phonons.ipynb)


## Calculation outputs
Expand Down
32 changes: 26 additions & 6 deletions docs/source/user_guide/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,33 @@
Python interface
================

Jupyter Notebook tutorials illustrating the use of currently available calculations can be found in the `janus-tutorials <https://github.com/stfc/janus-tutorials>`_ repository. This currently includes examples for:
Jupyter Notebook tutorials illustrating the use of currently available calculations can be found in the `tutorials <https://github.com/stfc/janus-core/tree/main/docs/source/tutorials>`_ documentation directory. This currently includes examples for:

- `Single Point <https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/single_point.ipynb>`_
- `Geometry Optimization <https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/geom_opt.ipynb>`_
- `Molecular Dynamics <https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/md.ipynb>`_
- `Equation of State <https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/eos.ipynb>`_
- `Phonons <https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/phonons.ipynb>`_
.. |single_point| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/single_point.ipynb
:alt: Launch single point Colab

.. |geom_opt| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/geom_opt.ipynb
:alt: Launch geometry optimisation Colab

.. |md| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/md.ipynb
:alt: Launch molecular dynamics Colab

.. |eos| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/eos.ipynb
:alt: Launch equation of state Colab

.. |phonons| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/stfc/janus-core/blob/main/docs/source/tutorials/phonons.ipynb
:alt: Launch phonons Colab

- :doc:`Single Point </tutorials/single_point>` |single_point|
- :doc:`Geometry Optimization </tutorials/geom_opt>` |geom_opt|
- :doc:`Molecular Dynamics </tutorials/md>` |md|
- :doc:`Equation of State </tutorials/eos>` |eos|
- :doc:`Phonons </tutorials/phonons>` |phonons|


Calculation outputs
Expand Down

0 comments on commit 77ab91d

Please sign in to comment.