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

# 

# LSST Data Management System 

# 

# This product includes software developed by the 

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

# 

# See COPYRIGHT file at the top of the source tree. 

# 

# 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 LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <https://www.lsstcorp.org/LegalNotices/>. 

# 

__all__ = ['get_ldf_env'] 

 

from datetime import datetime, timezone 

import os 

 

 

def get_ldf_env(): 

"""Gather metadata entries from LSST Data Facility environment. 

 

Returns 

------- 

prov : `dict` 

Dictionary of metadata items obtained from the LDF environment. 

Fields are: 

 

- ``'date'``: ISO8601-formatted current datetime. 

- ``'dataset'``: the name of the dataset processed. 

- ``'dataset_repo_url'``: a reference URL with information about the 

dataset. 

- ``run_id``: ID of the run in the LDF environment. 

- ``run_id_url``: a reference URL with information about the run. 

- ``version_tag``: the version of the LSST stack used. 

 

Examples 

-------- 

This metadata is intended to be inserted into a job's metadata: 

 

>>> from lsst.verify import Job 

>>> job = Job() 

>>> job.meta.update(get_ldf_env()) 

""" 

 

return { 

'date': datetime.now(timezone.utc).isoformat(), 

'dataset': os.getenv('DATASET', 'unknown'), 

'dataset_repo_url': os.getenv('DATASET_REPO_URL', 

'https://example.com'), 

'run_id': os.getenv('RUN_ID', 'unknown'), 

'run_id_url': os.getenv('RUN_ID_URL', 'https://example.com'), 

'version_tag': os.getenv('VERSION_TAG', 'unknown') 

}