Coverage for biobb_io/api/memprotmd_sim.py: 75%

40 statements  

« prev     ^ index     » next       coverage.py v7.3.1, created at 2023-09-07 10:41 +0000

1#!/usr/bin/env python 

2 

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

4import argparse 

5from biobb_common.generic.biobb_object import BiobbObject 

6from biobb_common.configuration import settings 

7from biobb_common.tools.file_utils import launchlogger 

8from biobb_io.api.common import check_output_path, check_mandatory_property, get_memprotmd_sim 

9 

10 

11class MemProtMDSim(BiobbObject): 

12 """ 

13 | biobb_io MemProtMDSim 

14 | This class is a wrapper of the MemProtMD to download a simulation using its REST API. 

15 | Wrapper for the `MemProtMD DB REST API <http://memprotmd.bioch.ox.ac.uk/>`_ to download a simulation. 

16 

17 Args: 

18 output_simulation (str): Path to the output simulation in a ZIP file. File type: output. `Sample file <https://github.com/bioexcel/biobb_io/raw/master/biobb_io/test/reference/api/output_sim.zip>`_. Accepted formats: zip (edam:format_3987). 

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

20 * **pdb_code** (*str*) - (None) RSCB PDB code. 

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

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

23 

24 Examples: 

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

26 

27 from biobb_io.api.memprotmd_sim import memprotmd_sim 

28 prop = { 

29 'pdb_code': '2VGB' 

30 } 

31 memprotmd_sim(output_simulation='/path/to/newSimulation.zip', 

32 properties=prop) 

33 

34 Info: 

35 * wrapped_software: 

36 * name: MemProtMD DB 

37 * license: Creative Commons 

38 * ontology: 

39 * name: EDAM 

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

41 

42 """ 

43 

44 def __init__(self, output_simulation, 

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

46 properties = properties or {} 

47 

48 # Call parent class constructor 

49 super().__init__(properties) 

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

51 

52 # Input/Output files 

53 self.io_dict = { 

54 "out": {"output_simulation": output_simulation} 

55 } 

56 

57 # Properties specific for BB 

58 self.pdb_code = properties.get('pdb_code', None) 

59 self.properties = properties 

60 

61 # Check the properties 

62 self.check_properties(properties) 

63 self.check_arguments() 

64 

65 def check_data_params(self, out_log, err_log): 

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

67 self.output_simulation = check_output_path(self.io_dict["out"]["output_simulation"], "output_simulation", False, out_log, self.__class__.__name__) 

68 

69 @launchlogger 

70 def launch(self) -> int: 

71 """Execute the :class:`MemProtMDSim <api.memprotmd_sim.MemProtMDSim>` api.memprotmd_sim.MemProtMDSim object.""" 

72 

73 # check input/output paths and parameters 

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

75 

76 # Setup Biobb 

77 if self.check_restart(): 

78 return 0 

79 

80 check_mandatory_property(self.pdb_code, 'pdb_code', self.out_log, self.__class__.__name__) 

81 

82 # get simulation files and save to output 

83 get_memprotmd_sim(self.pdb_code, self.output_simulation, self.out_log, self.global_log) 

84 

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

86 

87 return 0 

88 

89 

90def memprotmd_sim(output_simulation: str, properties: dict = None, **kwargs) -> int: 

91 """Execute the :class:`MemProtMDSim <api.memprotmd_sim.MemProtMDSim>` class and 

92 execute the :meth:`launch() <api.memprotmd_sim.MemProtMDSim.launch>` method.""" 

93 

94 return MemProtMDSim(output_simulation=output_simulation, 

95 properties=properties, **kwargs).launch() 

96 

97 

98def main(): 

99 """Command line execution of this building block. Please check the command line documentation.""" 

100 parser = argparse.ArgumentParser(description="Wrapper for the MemProtMD DB REST API (http://memprotmd.bioch.ox.ac.uk/) to download a simulation.", formatter_class=lambda prog: argparse.RawTextHelpFormatter(prog, width=99999)) 

101 parser.add_argument('-c', '--config', required=False, help="This file can be a YAML file, JSON file or JSON string") 

102 

103 # Specific args of each building block 

104 required_args = parser.add_argument_group('required arguments') 

105 required_args.add_argument('-o', '--output_simulation', required=True, help="Path to the output simulation in a ZIP file. Accepted formats: zip.") 

106 

107 args = parser.parse_args() 

108 config = args.config if args.config else None 

109 properties = settings.ConfReader(config=config).get_prop_dic() 

110 

111 # Specific call of each building block 

112 memprotmd_sim(output_simulation=args.output_simulation, 

113 properties=properties) 

114 

115 

116if __name__ == '__main__': 

117 main()