Skip to content

Commit

Permalink
Merge branch 'main' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
kavanase committed Jan 31, 2025
2 parents b2fa22c + 072a140 commit 96570f3
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
11 changes: 11 additions & 0 deletions docs/Tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
Tutorials
===========================================================

Literature
----------

- **YouTube Overview (14 mins)**: `doped: Python package for charged defect supercell calculations <https://www.youtube.com/watch?v=-Z-R9sedeqY>`__
- **Code Paper**: S\. R. Kavanagh et al. `doped: Python toolkit for robust and repeatable charged defect supercell calculations <https://doi.org/10.21105/joss.06433>`__. *Journal of Open Source Software* 9 (96), 6433, **2024**
- **General Defect Modelling Tutorial Video**: `Modelling Point Defects in Semiconductors with VASP <https://www.youtube.com/watch?v=FWz7nm9qoNg&ab_channel=Se%C3%A1nR.Kavanagh>`__
- **ShakeNBreak Documentation**: `ShakeNBreak Documentation <https://shakenbreak.readthedocs.io/en/latest/>`__

Code Tutorials
--------------

The typical defect calculation, parsing and analysis workflow using ``doped`` is exemplified through the
tutorials:

Expand Down
4 changes: 2 additions & 2 deletions docs/YT_defects_tutorial.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
YouTube Defects Tutorial
========================
YouTube Defect Modelling Tutorial
=================================

.. raw:: html

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Studies using ``doped``, so far
Acknowledgements
================

``doped`` (née `DefectsWithTheBoys`) has benefitted from feedback from many users, in particular
``doped`` (née ``DefectsWithTheBoys``) has benefitted from feedback from many users, in particular
members of the `Scanlon <http://davidscanlon.com/>`_ and
`Walsh <https://wmd-group.github.io/>`_ research groups who have / are using it in their work.
Direct contributors are listed in the GitHub ``Contributors`` sidebar; including Seán Kavanagh,
Expand Down

0 comments on commit 96570f3

Please sign in to comment.