Skip to content

Commit e06c3c4

Browse files
committed
Added docs help and cleaning of remove sandbox
1 parent 4c30910 commit e06c3c4

15 files changed

+54
-17
lines changed

biobb_structure_utils/utils/cat_pdb.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ def launch(self) -> int:
131131
self.copy_to_host()
132132

133133
# Remove temporal files
134-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
134+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
135135
self.remove_tmp_files()
136136

137137
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -157,6 +157,8 @@ def cat_pdb(
157157
**kwargs,
158158
).launch()
159159

160+
cat_pdb.__doc__ = CatPDB.__doc__
161+
160162

161163
def main():
162164
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/closest_residues.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ def launch(self) -> int:
208208
self.copy_to_host()
209209

210210
# Remove temporal files
211-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
211+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
212212
self.remove_tmp_files()
213213

214214
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -232,6 +232,8 @@ def closest_residues(
232232
**kwargs,
233233
).launch()
234234

235+
closest_residues.__doc__ = ClosestResidues.__doc__
236+
235237

236238
def main():
237239
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/extract_atoms.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ def launch(self) -> int:
154154
self.copy_to_host()
155155

156156
# Remove temporal files
157-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
157+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
158158
self.remove_tmp_files()
159159

160160
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -178,6 +178,8 @@ def extract_atoms(
178178
**kwargs,
179179
).launch()
180180

181+
extract_atoms.__doc__ = ExtractAtoms.__doc__
182+
181183

182184
def main():
183185
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/extract_chain.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def launch(self) -> int:
151151
self.copy_to_host()
152152

153153
# Remove temporal files
154-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
154+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
155155
self.remove_tmp_files()
156156

157157
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -191,6 +191,8 @@ def extract_chain(
191191
**kwargs,
192192
).launch()
193193

194+
extract_chain.__doc__ = ExtractChain.__doc__
195+
194196

195197
def main():
196198
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/extract_heteroatoms.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ def launch(self) -> int:
170170
self.copy_to_host()
171171

172172
# Remove temporal files
173-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
173+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
174174
self.remove_tmp_files()
175175

176176
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -194,6 +194,8 @@ def extract_heteroatoms(
194194
**kwargs,
195195
).launch()
196196

197+
extract_heteroatoms.__doc__ = ExtractHeteroAtoms.__doc__
198+
197199

198200
def main():
199201
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/extract_model.py

+6-3
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,10 @@ def launch(self) -> int:
148148
self.copy_to_host()
149149

150150
# Remove temporal files
151-
self.tmp_files.extend(
152-
[self.stage_io_dict.get("unique_dir", ""), tmp_folder]
153-
)
151+
self.tmp_files.extend([
152+
# self.stage_io_dict.get("unique_dir", ""),
153+
tmp_folder
154+
])
154155
self.remove_tmp_files()
155156

156157
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -190,6 +191,8 @@ def extract_model(
190191
**kwargs,
191192
).launch()
192193

194+
extract_model.__doc__ = ExtractModel.__doc__
195+
193196

194197
def main():
195198
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/extract_molecule.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,10 @@ def launch(self) -> int:
146146
self.copy_to_host()
147147

148148
# Remove temporal files
149-
self.tmp_files.extend([self.stage_io_dict.get("unique_dir", ""), tmp_folder])
149+
self.tmp_files.extend([
150+
self.stage_io_dict.get("unique_dir", ""),
151+
# tmp_folder
152+
])
150153
self.remove_tmp_files()
151154

152155
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -170,6 +173,8 @@ def extract_molecule(
170173
**kwargs,
171174
).launch()
172175

176+
extract_molecule.__doc__ = ExtractMolecule.__doc__
177+
173178

174179
def main():
175180
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/extract_residues.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ def launch(self) -> int:
157157
self.copy_to_host()
158158

159159
# Remove temporal files
160-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
160+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
161161
self.remove_tmp_files()
162162

163163
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -181,6 +181,8 @@ def extract_residues(
181181
**kwargs,
182182
).launch()
183183

184+
extract_residues.__doc__ = ExtractResidues.__doc__
185+
184186

185187
def main():
186188
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/remove_ligand.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def launch(self) -> int:
122122
self.copy_to_host()
123123

124124
# Remove temporal files
125-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
125+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
126126
self.remove_tmp_files()
127127

128128
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -146,6 +146,8 @@ def remove_ligand(
146146
**kwargs,
147147
).launch()
148148

149+
remove_ligand.__doc__ = RemoveLigand.__doc__
150+
149151

150152
def main():
151153
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/remove_molecules.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ def launch(self) -> int:
162162
self.copy_to_host()
163163

164164
# Remove temporal files
165-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
165+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
166166
self.remove_tmp_files()
167167

168168
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -186,6 +186,8 @@ def remove_molecules(
186186
**kwargs,
187187
).launch()
188188

189+
remove_molecules.__doc__ = RemoveMolecules.__doc__
190+
189191

190192
def main():
191193
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/remove_pdb_water.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def launch(self) -> int:
9595
self.copy_to_host()
9696

9797
# Remove temporal files
98-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
98+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
9999
self.remove_tmp_files()
100100

101101
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -119,6 +119,8 @@ def remove_pdb_water(
119119
**kwargs,
120120
).launch()
121121

122+
remove_pdb_water.__doc__ = RemovePdbWater.__doc__
123+
122124

123125
def main():
124126
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/renumber_structure.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ def launch(self) -> int:
177177
self.copy_to_host()
178178

179179
# Remove temporal files
180-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
180+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
181181
self.remove_tmp_files()
182182

183183
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -203,6 +203,8 @@ def renumber_structure(
203203
**kwargs,
204204
).launch()
205205

206+
renumber_structure.__doc__ = RenumberStructure.__doc__
207+
206208

207209
def main():
208210
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/sort_gro_residues.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ def launch(self) -> int:
9494
self.copy_to_host()
9595

9696
# Remove temporal files
97-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
97+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
9898
self.remove_tmp_files()
9999

100100
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -118,6 +118,8 @@ def sort_gro_residues(
118118
**kwargs,
119119
).launch()
120120

121+
sort_gro_residues.__doc__ = SortGroResidues.__doc__
122+
121123

122124
def main():
123125
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/str_check_add_hydrogens.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ def launch(self) -> int:
145145
check_output_end(self.io_dict["out"]["output_structure_path"], self.out_log)
146146

147147
# Remove temporal files
148-
self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
148+
# self.tmp_files.append(self.stage_io_dict.get("unique_dir", ""))
149149
self.remove_tmp_files()
150150

151151
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -169,6 +169,8 @@ def str_check_add_hydrogens(
169169
**kwargs,
170170
).launch()
171171

172+
str_check_add_hydrogens.__doc__ = StrCheckAddHydrogens.__doc__
173+
172174

173175
def main():
174176
"""Command line execution of this building block. Please check the command line documentation."""

biobb_structure_utils/utils/structure_check.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,10 @@ def launch(self) -> int:
151151
self.copy_to_host()
152152

153153
# Remove temporal files
154-
self.tmp_files.extend([self.stage_io_dict.get("unique_dir", ""), tmp_folder]) # type: ignore
154+
self.tmp_files.extend([
155+
# self.stage_io_dict.get("unique_dir", ""),
156+
tmp_folder
157+
])
155158
self.remove_tmp_files()
156159

157160
self.check_arguments(output_files_created=True, raise_exception=False)
@@ -175,6 +178,8 @@ def structure_check(
175178
**kwargs,
176179
).launch()
177180

181+
structure_check.__doc__ = StructureCheck.__doc__
182+
178183

179184
def main():
180185
"""Command line execution of this building block. Please check the command line documentation."""

0 commit comments

Comments
 (0)