Skip to content

Software

Bases: UUIDBaseNode

Definition

The Software node contains metadata for a computation tool, code, programming language, or software package.

Similar to the reference node, the software node does not contain the base attributes and is meant to always be public and static.

Can Be Added To:

Available sub-objects

  • None

Attributes

attribute type example description required vocab
name str LAMMPS type of literature True
version str 23Jun22 software version True
source str lammps.org source of software

JSON Representation

{
   "name":"SOMA",
   "node":["Software"],
   "version":"0.7.0"
   "source":"https://gitlab.com/InnocentBug/SOMA",
   "uid":"_:f2ec4bf2-96aa-48a3-bfbc-d1d3f090583b",
   "uuid":"f2ec4bf2-96aa-48a3-bfbc-d1d3f090583b",
}
Source code in src/cript/nodes/subobjects/software.py 
  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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
class Software(UUIDBaseNode):
    """
    ## Definition

    The [Software](https://pubs.acs.org/doi/suppl/10.1021/acscentsci.3c00011/suppl_file/oc3c00011_si_001.pdf#page=16)
    node contains metadata for a computation tool, code, programming language, or software package.

    Similar to the [reference](../../primary_nodes/reference) node, the software node does not contain the base
    attributes and is meant to always be public and static.

    ---

    ## Can Be Added To:
    * [Software_Configuration](../../subobjects/software_configuration)

    ## Available sub-objects
    * None

    ---

    ## Attributes

    | attribute | type | example    | description                   | required | vocab |
    |-----------|------|------------|-------------------------------|----------|-------|
    | name      | str  | LAMMPS     | type of literature            | True     |       |
    | version   | str  | 23Jun22    | software version              | True     |       |
    | source    | str  | lammps.org | source of software            |          |       |

    ## JSON Representation
    ```json
    {
       "name":"SOMA",
       "node":["Software"],
       "version":"0.7.0"
       "source":"https://gitlab.com/InnocentBug/SOMA",
       "uid":"_:f2ec4bf2-96aa-48a3-bfbc-d1d3f090583b",
       "uuid":"f2ec4bf2-96aa-48a3-bfbc-d1d3f090583b",
    }
    ```
    """

    @dataclass(frozen=True)
    class JsonAttributes(UUIDBaseNode.JsonAttributes):
        name: str = ""
        version: str = ""
        source: str = ""

    _json_attrs: JsonAttributes = JsonAttributes()

    @beartype
    def __init__(self, name: str, version: str, source: str = "", **kwargs):
        """
        create Software node

        Parameters
        ----------
        name : str
            Software name
        version : str
            Software version
        source : str, optional
            Software source, by default ""

        Examples
        --------
        >>> import cript
        >>> my_software = cript.Software(
        ...     name="my software name", version="v1.0.0", source="https://myurl.com"
        ... )

        Returns
        -------
        None
            create Software node
        """
        super().__init__(**kwargs)

        self._json_attrs = replace(self._json_attrs, name=name, version=version, source=source)
        self.validate()

    @property
    @beartype
    def name(self) -> str:
        """
        Software name

        Examples
        --------
        >>> import cript
        >>> my_software = cript.Software(
        ...     name="my software name", version="v1.0.0", source="https://myurl.com"
        ... )
        >>> my_software.name = "my software name"

        Returns
        -------
        str
            Software name
        """
        return self._json_attrs.name

    @name.setter
    @beartype
    def name(self, new_name: str) -> None:
        """
        set the name of the Software node

        Parameters
        ----------
        new_name : str
            new Software name

        Returns
        -------
        None
        """
        new_attr = replace(self._json_attrs, name=new_name)
        self._update_json_attrs_if_valid(new_attr)

    @property
    @beartype
    def version(self) -> str:
        """
        Software version

        Examples
        --------
        >>> import cript
        >>> my_software = cript.Software(
        ...     name="my software name", version="v1.0.0", source="https://myurl.com"
        ... )
        >>> my_software.version = "1.2.3"

        Returns
        -------
        str
            Software version
        """
        return self._json_attrs.version

    @version.setter
    @beartype
    def version(self, new_version: str) -> None:
        """
        set the Software version

        Parameters
        ----------
        new_version : str
            new Software version

        Returns
        -------
        None
        """
        new_attr = replace(self._json_attrs, version=new_version)
        self._update_json_attrs_if_valid(new_attr)

    @property
    @beartype
    def source(self) -> str:
        """
        Software source

        Examples
        --------
        >>> import cript
        >>> my_software = cript.Software(
        ...     name="my software name", version="v1.0.0", source="https://myurl.com"
        ... )
        >>> my_software.source = "https://myNewWebsite.com"

        Returns
        -------
        str
            Software source
        """
        return self._json_attrs.source

    @source.setter
    @beartype
    def source(self, new_source: str) -> None:
        """
        set the Software source

        Parameters
        ----------
        new_source : str
            new Software source

        Returns
        -------
        None
        """
        new_attr = replace(self._json_attrs, source=new_source)
        self._update_json_attrs_if_valid(new_attr)

name: str property writable

Software name

Examples:

>>> import cript
>>> my_software = cript.Software(
...     name="my software name", version="v1.0.0", source="https://myurl.com"
... )
>>> my_software.name = "my software name"

Returns:

Type Description
str

Software name

source: str property writable

Software source

Examples:

>>> import cript
>>> my_software = cript.Software(
...     name="my software name", version="v1.0.0", source="https://myurl.com"
... )
>>> my_software.source = "https://myNewWebsite.com"

Returns:

Type Description
str

Software source

version: str property writable

Software version

Examples:

>>> import cript
>>> my_software = cript.Software(
...     name="my software name", version="v1.0.0", source="https://myurl.com"
... )
>>> my_software.version = "1.2.3"

Returns:

Type Description
str

Software version

__init__(name, version, source='', **kwargs)

create Software node

Parameters:

Name Type Description Default
name str

Software name

 required
version str

Software version

 required
source str

Software source, by default ""

 ''

Examples:

>>> import cript
>>> my_software = cript.Software(
...     name="my software name", version="v1.0.0", source="https://myurl.com"
... )

Returns:

Type Description
None

create Software node
Source code in src/cript/nodes/subobjects/software.py 
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
@beartype
def __init__(self, name: str, version: str, source: str = "", **kwargs):
    """
    create Software node

    Parameters
    ----------
    name : str
        Software name
    version : str
        Software version
    source : str, optional
        Software source, by default ""

    Examples
    --------
    >>> import cript
    >>> my_software = cript.Software(
    ...     name="my software name", version="v1.0.0", source="https://myurl.com"
    ... )

    Returns
    -------
    None
        create Software node
    """
    super().__init__(**kwargs)

    self._json_attrs = replace(self._json_attrs, name=name, version=version, source=source)
    self.validate()