Coverage for python / lsst / ctrl / execute / allocationConfig.py: 100%

1# This file is part of ctrl_execute. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (https://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <https://www.gnu.org/licenses/>. 

27 

28import lsst.pex.config as pexConfig 

29 

30 

31class AllocatedPlatformConfig(pexConfig.Config): 

32 """Platform specific information""" 

33 

34 queue = pexConfig.Field(doc="the scheduler queue to submit to", dtype=str, default="debug") 

35 email = pexConfig.Field( 

36 doc="line to add to the scheduler file to get email notification (if supported)", 

37 dtype=str, 

38 default=None, 

39 ) 

40 

41 scratchDirectory = pexConfig.Field( 

42 doc="directory on the remote system where the scheduler file is sent", 

43 dtype=str, 

44 default=None, 

45 ) 

46 loginHostName = pexConfig.Field(doc="the host to login and copy files to", dtype=str, default=None) 

47 utilityPath = pexConfig.Field( 

48 doc="the directory containing the scheduler commands", dtype=str, default=None 

49 ) 

50 totalCoresPerNode = pexConfig.Field(doc="the TOTAL number of cores on each node", dtype=int, default=1) 

51 glideinShutdown = pexConfig.Field( 

52 doc="number of seconds of inactivity before glideins are cancelled", 

53 dtype=int, 

54 default=3600, 

55 ) 

56 

57 

58class AllocationConfig(pexConfig.Config): 

59 """A pex_config file describing the platform specific information required 

60 to fill out a scheduler file which will be used to submit a scheduler 

61 request. 

62 """ 

63 

64 # this is done on two levels instead of one for future expansion of this 

65 # config class, which may require local attributes to be specified. 

66 platform = pexConfig.ConfigField("platform allocation information", AllocatedPlatformConfig)