Test Failed
Push — master ( 2ea9aa...bc518a )
by
unknown
01:19 queued 17s
created

FrameworkCitationsTools.citation3()   A

Complexity

Conditions 1

Size

Total Lines 2
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nop 1
dl 0
loc 2
rs 10
c 0
b 0
f 0
1
# Copyright 2014 Diamond Light Source Ltd.
2
#
3
# Licensed under the Apache License, Version 2.0 (the "License");
4
# you may not use this file except in compliance with the License.
5
# You may obtain a copy of the License at
6
#
7
#     http://www.apache.org/licenses/LICENSE-2.0
8
#
9
# Unless required by applicable law or agreed to in writing, software
10
# distributed under the License is distributed on an "AS IS" BASIS,
11
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
# See the License for the specific language governing permissions and
13
# limitations under the License.
14
15
"""
16
.. module:: framework_citations_tools
17
   :platform: Unix
18
   :synopsis: Contains all framework citations.
19
20
.. moduleauthor:: Jessica Verschoyle <[email protected]>
21
22
"""
23
from savu.plugins.plugin_tools import PluginTools
24
25
class FrameworkCitationsTools(PluginTools):
26
    """Framework citation text"""
27
28
    def citation(self):
29
        """
30
        The Savu online repository
31
        bibtex:
32
            @software{nicola_wadeson_2021_5095360,
33
            author={Nicola Wadeson and
34
                      Jessica Verschoyle and
35
                      Daniil Kazantsev and
36
                      Mark Basham and
37
                      Dimitar Tasev and
38
                      Nghia T. Vo and
39
                      Tom Schoonjans and
40
                      Emilio PJ and
41
                      mjn19172 and
42
                      Srikanth Nagella and
43
                      Dan Nixon and
44
                      mstorm and
45
                      Matthew Frost and
46
                      cgowling and
47
                      Robert C Atwood and
48
                      Gabryel Mason-Williams and
49
                      Jacob Filik and
50
                      Katrin Leinweber and
51
                      Making GitHub Delicious. and
52
                      The Gitter Badger and
53
                      Willem Jan Palenstijn and
54
                      Zdenek},
55
            title={DiamondLightSource/Savu: Version 4.0},
56
            month=jul,
57
            year=2021,
58
            publisher={Zenodo},
59
            version={v4.0},
60
            doi={10.5281/zenodo.5095360},
61
            url={https://doi.org/10.5281/zenodo.5095360}
62
            }
63
        short_name_article: Savu repository
64
        doi: 10.5281/zenodo.5095360
65
        """
66
67
    def citation1(self):
68
        """
69
        The Savu framework design is described in this paper.
70
        bibtex:
71
                @article{wadeson2016savu,
72
                title={Savu: A Python-based, MPI Framework for Simultaneous
73
                Processing of Multiple, N-dimensional, Large Tomography
74
                Datasets},
75
                author={Wadeson, Nicola and Basham, Mark},
76
                journal={arXiv preprint arXiv:1610.08015},
77
                year={2016}
78
                }
79
        endnote:
80
                %0 Journal Article
81
                %T Savu: A Python-based, MPI Framework for Simultaneous Processing
82
                of Multiple, N-dimensional, Large Tomography Datasets
83
                %A Wadeson, Nicola
84
                %A Basham, Mark
85
                %J arXiv preprint arXiv:1610.08015
86
                %D 2016
87
        short_name_article: Savu
88
89
        """
90
91
    def citation2(self):
92
        """
93
        Savu uses parallel HDF5 as a backend.
94
        bibtex:
95
                @ONLINE{hdf5,
96
                author = {{The HDF Group}},
97
                title = '{Hierarchical Data Format, version 5}',
98
                year = {1997-2016},
99
                note = {/HDF5/},
100
                }
101
        endnote:
102
                %0 Journal Article
103
                %T {Hierarchical Data Format, version 5}
104
                %A HDF Group
105
                %D 2014
106
        short_name_article: Hdf5
107
        """
108
109
    def citation3(self):
110
        """
111
        HDF5 uses the Message Passing Interface standard for interprocess
112
         communication
113
        bibtex:
114
                @article{walker1996mpi,
115
                title={MPI: a standard message passing interface},
116
                author={Walker, David W and Dongarra, Jack J},
117
                journal={Supercomputer},
118
                volume={12},
119
                pages={56--68},
120
                year={1996},
121
                publisher={ASFRA BV}
122
                }
123
        endnote:
124
                %0 Journal Article
125
                %T MPI: a standard message passing interface
126
                %A Walker, David W
127
                %A Dongarra, Jack J
128
                %J Supercomputer
129
                %V 12
130
                %P 56-68
131
                %@ 0168-7875
132
                %D 1996
133
                %I ASFRA BV
134
        short_name_article: MPI
135
136
        """