From b29617536089d48626fdb3c43646f481ddcd590d Mon Sep 17 00:00:00 2001
From: mkirsz <s1351949@sms.ed.ac.uk>
Date: Fri, 13 Dec 2024 18:48:13 +0000
Subject: [PATCH] swriter docs

---
 docs/source/cli.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/source/cli.rst b/docs/source/cli.rst
index f553b3e..be3176b 100644
--- a/docs/source/cli.rst
+++ b/docs/source/cli.rst
@@ -9,6 +9,7 @@ Features
 - **Hyperparameter Optimization**: Optimize model architecture and hyperparameters.
 - **Database Conversion**: Process computational datasets into Tadah! database format.
 - **Database Management**: Identify duplicates, join, split, and sample datasets.
+- **Structure  Writer**: Seamless integration with CASTEP, VASP and LAMMPS.
 - **Descriptor Calculation**: Calculate descriptors for datasets using a potential file.
 - **Plotting Toolkit**: Visualize basis functions, cutoffs, and two-body potentials.
 
@@ -114,6 +115,19 @@ Examples:
   - ``tadah db sample -d dataset1.tadah dataset2.tadah -o sample_data.tadah -e 10 -m`` : Evenly sample every 10 entries and merge.
   - ``tadah db sample -d dataset.tadah -o sample_data.tadah -i 1,2,5-10`` : Sample specific indices.
 
+Structure Writer
+................
+
+This tool allows you to convert a structure from Tadah! dataset into one of:
+
+  - **VASP**: ``POSCAR/CONTCAR``
+  - **CASTEP**: ``.cell``
+  - **LAMMPS**: ``read_data format``
+
+Examples:
+
+  - ``tadah swriter -d db.tadah -i 7 -f castep -o structure7.cell`` : Dump structure 7 to castep .cell format.
+
 Descriptor Calculation
 ......................
 
-- 
GitLab