Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

# 

# This file is part of ap_verify. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

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

# for details of code ownership. 

# 

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

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

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

# (at your option) any later version. 

# 

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

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

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

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

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

# 

 

import os 

import pathlib 

import stat 

 

import lsst.daf.persistence as dafPersist 

 

 

class Workspace: 

"""A directory used by ``ap_verify`` to handle data. 

 

Any object of this class represents a working directory containing 

(possibly empty) subdirectories for repositories. At present, constructing 

a Workspace does not *initialize* its repositories; for compatibility 

reasons, this is best deferred to individual tasks. 

 

Parameters 

---------- 

location : `str` 

The location on disk where the workspace will be set up. Will be 

created if it does not already exist. 

 

Raises 

------ 

EnvironmentError 

Raised if ``location`` is not readable or not writeable 

""" 

 

def __init__(self, location): 

self._location = location 

 

mode = stat.S_IRWXU | stat.S_IRGRP | stat.S_IROTH # a+r, u+rwx 

kwargs = {"parents": True, "exist_ok": True, "mode": mode} 

pathlib.Path(self._location).mkdir(**kwargs) 

pathlib.Path(self.configDir).mkdir(**kwargs) 

pathlib.Path(self.dataRepo).mkdir(**kwargs) 

pathlib.Path(self.calibRepo).mkdir(**kwargs) 

pathlib.Path(self.templateRepo).mkdir(**kwargs) 

pathlib.Path(self.outputRepo).mkdir(**kwargs) 

 

# Lazy evaluation to optimize workButler and analysisButler 

self._workButler = None 

self._analysisButler = None 

 

@property 

def configDir(self): 

"""The location of a directory containing custom Task config files for use with the data. 

""" 

return os.path.join(self._location, 'config') 

 

@property 

def dataRepo(self): 

"""The URI to a Butler repo for science data (`str`, read-only). 

""" 

return os.path.join(self._location, 'ingested') 

 

@property 

def calibRepo(self): 

"""The URI to a Butler repo for calibration data (`str`, read-only). 

""" 

return os.path.join(self._location, 'calibingested') 

 

@property 

def templateRepo(self): 

"""The URI to a Butler repo for precomputed templates (`str`, read-only). 

""" 

return self.dataRepo 

 

@property 

def outputRepo(self): 

"""The URI to a Butler repo for AP pipeline products (`str`, read-only). 

""" 

return os.path.join(self._location, 'output') 

 

@property 

def dbLocation(self): 

"""The default location of the source association database to be 

created or updated by the pipeline (`str`, read-only). 

 

Shall be a filename to a database file suitable 

for `AssociationDBSqliteTask`. 

""" 

return os.path.join(self._location, 'association.db') 

 

@property 

def workButler(self): 

"""A Butler that can produce pipeline inputs and outputs 

(`lsst.daf.persistence.Butler`, read-only). 

""" 

if self._workButler is None: 

self._workButler = self._makeButler() 

return self._workButler 

 

def _makeButler(self): 

"""Create a butler for accessing the entire workspace. 

 

Returns 

------- 

butler : `lsst.daf.persistence.Butler` 

A butler accepting `dataRepo`, `calibRepo`, and `templateRepo` as 

inputs, and `outputRepo` as an output. 

 

Notes 

----- 

Assumes all `*Repo` properties have been initialized. 

""" 

# common arguments for butler elements 

mapperArgs = {"calibRoot": os.path.abspath(self.calibRepo)} 

 

inputs = [{"root": self.dataRepo, "mapperArgs": mapperArgs}] 

outputs = [{"root": self.outputRepo, "mode": "rw", "mapperArgs": mapperArgs}] 

 

if not os.path.samefile(self.dataRepo, self.templateRepo): 

inputs.append({'root': self.templateRepo, 'mode': 'r', 'mapperArgs': mapperArgs}) 

 

return dafPersist.Butler(inputs=inputs, outputs=outputs) 

 

@property 

def analysisButler(self): 

"""A Butler that can read pipeline outputs (`lsst.daf.persistence.Butler`, read-only). 

""" 

if self._analysisButler is None: 

self._analysisButler = dafPersist.Butler(inputs={"root": self.outputRepo, "mode": "r"}) 

return self._analysisButler