[DOCS] Adding description to the stiffness modules

bioexcel · May 24, 2024 · f82f96e · f82f96e
1 parent 8342f40
commit f82f96e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/biobb_dna/stiffness/average_stiffness.py b/biobb_dna/stiffness/average_stiffness.py
@@ -20,6 +20,7 @@ class AverageStiffness(BiobbObject):
     """
     | biobb_dna AverageStiffness
     | Calculate average stiffness constants for each base pair of a trajectory's series.
+    | Calculate the average stiffness constants for each base pair of a trajectory's series. The input is a .ser file with the helical parameter values for each base/basepair. The output is a .csv file with the average stiffness constants for each base pair and a .jpg file with a plot of the average stiffness constants for each base pair.
 
     Args:
         input_ser_path (str): Path to .ser file for helical parameter. File is expected to be a table, with the first column being an index and the rest the helical parameter values for each base/basepair. File type: input. `Sample file <https://raw.githubusercontent.com/bioexcel/biobb_dna/master/biobb_dna/test/data/stiffness/canal_output_roll.ser>`_. Accepted formats: ser (edam:format_2330).

diff --git a/biobb_dna/stiffness/basepair_stiffness.py b/biobb_dna/stiffness/basepair_stiffness.py
@@ -19,6 +19,7 @@ class BPStiffness(BiobbObject):
     """
     | biobb_dna BPStiffness
     | Calculate stiffness constants matrix between all six helical parameters for a single base pair step.
+    | Calculate stiffness constants matrix between all six helical parameters for a single base pair step.
 
     Args:
         input_filename_shift (str): Path to csv file with data for helical parameter 'shift'. File type: input. `Sample file <https://raw.githubusercontent.com/bioexcel/biobb_dna/master/biobb_dna/test/data/stiffness/series_shift_AA.csv>`_. Accepted formats: csv (edam:format_3752)