Coverage for python/lsst/ctrl/bps/bps_draw.py: 83%

6 statements  

« prev     ^ index     » next       coverage.py v7.3.2, created at 2023-11-22 11:02 +0000

1# This file is part of ctrl_bps. 

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 

28"""Functions used to draw BPS graphs. 

29""" 

30import logging 

31 

32import networkx 

33 

34_LOG = logging.getLogger(__name__) 

35 

36 

37def draw_networkx_dot(graph, outname): 

38 """Save drawing of expanded graph to file. 

39 

40 Parameters 

41 ---------- 

42 graph : `networkx.DiGraph` 

43 The graph which graphical representation should be persisted. 

44 outname : `str` 

45 Output filename for drawn graph 

46 """ 

47 # Note: Leaving function here for now. Want to move 

48 # more of the drawing attributes, etc here in 

49 # the future. If pygraphviz makes it into the 

50 # stack can also use better layout functions. 

51 networkx.drawing.nx_pydot.write_dot(graph, outname)