Coverage for biobb_chemistry / acpype / acpype_params_cns.py: 93%

1#!/usr/bin/env python3 

2 

3"""Module containing the AcpypeParamsCNS class and the command line interface.""" 

4from typing import Optional 

5from biobb_common.generic.biobb_object import BiobbObject 

6from biobb_common.tools.file_utils import launchlogger 

7from biobb_chemistry.acpype.common import get_binary_path, check_input_path, check_output_path, get_basename, get_charge, create_unique_name, get_default_value, process_output_cns 

8 

9 

10class AcpypeParamsCNS(BiobbObject): 

11 """ 

12 | biobb_chemistry AcpypeParamsCNS 

13 | This class is a wrapper of `Acpype <https://github.com/alanwilter/acpype>`_ tool for small molecule parameterization for CNS/XPLOR MD package. 

14 | Generation of topologies for CNS/XPLOR. Acpype is a tool based in Python to use Antechamber to generate topologies for chemical compounds and to interface with others python applications like CCPN or ARIA. `Visit the official page <https://github.com/alanwilter/acpype>`_. 

15 

16 Args: 

17 input_path (str): Path to the input file. File type: input. `Sample file <https://github.com/bioexcel/biobb_chemistry/raw/master/biobb_chemistry/test/data/acpype/acpype.params.mol2>`_. Accepted formats: pdb (edam:format_1476), mdl (edam:format_3815), mol2 (edam:format_3816). 

18 output_path_par (str): Path to the PAR output file. File type: output. `Sample file <https://github.com/bioexcel/biobb_chemistry/raw/master/biobb_chemistry/test/reference/acpype/ref_acpype.cns.par>`_. Accepted formats: par (edam:format_3881). 

19 output_path_inp (str): Path to the INP output file. File type: output. `Sample file <https://github.com/bioexcel/biobb_chemistry/raw/master/biobb_chemistry/test/reference/acpype/ref_acpype.cns.inp>`_. Accepted formats: inp (edam:format_3878). 

20 output_path_top (str): Path to the TOP output file. File type: output. `Sample file <https://github.com/bioexcel/biobb_chemistry/raw/master/biobb_chemistry/test/reference/acpype/ref_acpype.cns.top>`_. Accepted formats: top (edam:format_3881). 

21 output_path_pdb (str): Path to the PDB output file. File type: output. `Sample file <https://github.com/bioexcel/biobb_chemistry/raw/master/biobb_chemistry/test/reference/acpype/ref_acpype.cns.pdb>`_. Accepted formats: pdb (edam:format_1476). 

22 properties (dic - Python dictionary object containing the tool parameters, not input/output files): 

23 * **basename** (*str*) - ("BBB") A basename for the project (folder and output files). 

24 * **charge** (*int*) - (0) [-20~20|1] Net molecular charge, for gas default is 0. If None the charge is guessed by acpype. 

25 * **binary_path** (*str*) - ("acpype") Path to the acpype executable binary. 

26 * **remove_tmp** (*bool*) - (True) [WF property] Remove temporal files. 

27 * **restart** (*bool*) - (False) [WF property] Do not execute if output files exist. 

28 * **sandbox_path** (*str*) - ("./") [WF property] Parent path to the sandbox directory. 

29 * **container_path** (*str*) - (None) Container path definition. 

30 * **container_image** (*str*) - ('acpype/acpype:2022.7.21') Container image definition. 

31 * **container_volume_path** (*str*) - ('/tmp') Container volume path definition. 

32 * **container_working_dir** (*str*) - (None) Container working directory definition. 

33 * **container_user_id** (*str*) - (None) Container user_id definition. 

34 * **container_shell_path** (*str*) - ('/bin/bash') Path to default shell inside the container. 

35 

36 Examples: 

37 This is a use example of how to use the building block from Python:: 

38 

39 from biobb_chemistry.acpype.acpype_params_cns import acpype_params_cns 

40 prop = { 

41 'basename': 'BBB', 

42 'charge': 0 

43 } 

44 acpype_params_cns(input_path='/path/to/myStructure.mol2', 

45 output_path_par='/path/to/newPAR.par', 

46 output_path_inp='/path/to/newINP.inp', 

47 output_path_top='/path/to/newTOP.top', 

48 output_path_top='/path/to/newPDB.pdb', 

49 properties=prop) 

50 

51 Info: 

52 * wrapped_software: 

53 * name: Acpype 

54 * version: 2019.10.05.12.26 

55 * license: GNU 

56 * ontology: 

57 * name: EDAM 

58 * schema: http://edamontology.org/EDAM.owl 

59 

60 """ 

61 

62 def __init__(self, input_path, output_path_par, output_path_inp, output_path_top, output_path_pdb, 

63 properties=None, **kwargs) -> None: 

64 properties = properties or {} 

65 

66 # Call parent class constructor 

67 super().__init__(properties) 

68 self.locals_var_dict = locals().copy() 

69 

70 # Input/Output files 

71 self.io_dict = { 

72 "in": {"input_path": input_path}, 

73 "out": {"output_path_par": output_path_par, "output_path_inp": output_path_inp, "output_path_top": output_path_top, "output_path_pdb": output_path_pdb} 

74 } 

75 

76 # Properties specific for BB 

77 self.basename = properties.get('basename', 'BBB') 

78 self.charge = properties.get('charge', '') 

79 self.binary_path = get_binary_path(properties, 'binary_path') 

80 self.properties = properties 

81 

82 # Check the properties 

83 self.check_properties(properties) 

84 self.check_arguments() 

85 

86 def check_data_params(self, out_log, err_log): 

87 """ Checks all the input/output paths and parameters """ 

88 self.io_dict["in"]["input_path"] = check_input_path(self.io_dict["in"]["input_path"], out_log, self.__class__.__name__) 

89 self.io_dict["out"]["output_path_par"] = check_output_path(self.io_dict["out"]["output_path_par"], 'par', out_log, self.__class__.__name__) 

90 self.io_dict["out"]["output_path_inp"] = check_output_path(self.io_dict["out"]["output_path_inp"], 'inp', out_log, self.__class__.__name__) 

91 self.io_dict["out"]["output_path_top"] = check_output_path(self.io_dict["out"]["output_path_top"], 'top', out_log, self.__class__.__name__) 

92 self.io_dict["out"]["output_path_pdb"] = check_output_path(self.io_dict["out"]["output_path_pdb"], 'pdb', out_log, self.__class__.__name__) 

93 self.output_files = { 

94 'par': self.io_dict["out"]["output_path_par"], 

95 'inp': self.io_dict["out"]["output_path_inp"], 

96 'top': self.io_dict["out"]["output_path_top"], 

97 'pdb': self.io_dict["out"]["output_path_pdb"], 

98 } 

99 

100 def create_cmd(self, container_io_dict, out_log, err_log): 

101 """Creates the command line instruction using the properties file settings""" 

102 instructions_list = [] 

103 

104 # generating output path 

105 if self.container_path: 

106 out_pth = self.container_volume_path + '/' + get_basename(self.basename, out_log) + '.' + self.unique_name 

107 else: 

108 out_pth = get_basename(self.basename, out_log) + '.' + self.unique_name 

109 

110 # executable path 

111 instructions_list.append(self.binary_path) 

112 

113 # generating input 

114 ipath = '-i ' + container_io_dict["in"]["input_path"] 

115 instructions_list.append(ipath) 

116 

117 # generating output 

118 basename = '-b ' + out_pth 

119 instructions_list.append(basename) 

120 

121 # adding charge if not none 

122 charge = get_charge(self.charge, out_log) 

123 if charge: 

124 charge = '-n ' + charge 

125 instructions_list.append(charge) 

126 

127 return instructions_list 

128 

129 @launchlogger 

130 def launch(self) -> int: 

131 """Execute the :class:`AcpypeParamsCNS <acpype.acpype_params_cns.AcpypeParamsCNS>` acpype.acpype_params_cns.AcpypeParamsCNS object.""" 

132 

133 # check input/output paths and parameters 

134 self.check_data_params(self.out_log, self.err_log) 

135 

136 # Setup Biobb 

137 if self.check_restart(): 

138 return 0 

139 self.stage_files() 

140 

141 # create unique name for temporary folder (created by acpype) 

142 self.unique_name = create_unique_name(6) 

143 

144 # create command line instruction 

145 self.cmd = self.create_cmd(self.stage_io_dict, self.out_log, self.err_log) 

146 

147 # Run Biobb block 

148 self.run_biobb() 

149 

150 # Copy files to host 

151 self.copy_to_host() 

152 

153 # move files to output_path and removes temporary folder 

154 if self.container_path: 

155 process_output_cns( 

156 self.unique_name, 

157 # self.stage_io_dict['unique_dir'], 

158 self.remove_tmp, 

159 self.basename, 

160 get_default_value(self.__class__.__name__), 

161 self.output_files, self.out_log) 

162 else: 

163 self.tmp_files.append(self.basename + "." + self.unique_name + ".acpype") 

164 process_output_cns( 

165 self.unique_name, 

166 self.basename + "." + self.unique_name + ".acpype", 

167 self.remove_tmp, 

168 self.basename, 

169 get_default_value(self.__class__.__name__), 

170 self.output_files, self.out_log) 

171 

172 self.remove_tmp_files() 

173 self.check_arguments(output_files_created=True, raise_exception=False) 

174 

175 return self.return_code 

176 

177 

178def acpype_params_cns(input_path: str, output_path_par: str, output_path_inp: str, output_path_top: str, output_path_pdb: str, properties: Optional[dict] = None, **kwargs) -> int: 

179 """Create the :class:`AcpypeParamsCNS <acpype.acpype_params_cns.AcpypeParamsCNS>` class and 

180 execute the :meth:`launch() <acpype.acpype_params_cns.AcpypeParamsCNS.launch>` method.""" 

181 return AcpypeParamsCNS(**dict(locals())).launch() 

182 

183 

184acpype_params_cns.__doc__ = AcpypeParamsCNS.__doc__ 

185main = AcpypeParamsCNS.get_main(acpype_params_cns, "Small molecule parameterization for CNS/XPLOR MD package.") 

186 

187if __name__ == '__main__': 

188 main()