seer-pas-sdk 0.1.3__py3-none-any.whl → 3.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- seer_pas_sdk/auth/auth.py +23 -1
- seer_pas_sdk/common/__init__.py +370 -72
- seer_pas_sdk/common/errors.py +5 -0
- seer_pas_sdk/common/groupanalysis.py +55 -0
- seer_pas_sdk/core/sdk.py +1855 -371
- seer_pas_sdk/core/unsupported.py +1634 -0
- seer_pas_sdk/objects/__init__.py +2 -0
- seer_pas_sdk/objects/groupanalysis.py +30 -0
- seer_pas_sdk/objects/platemap.py +67 -22
- seer_pas_sdk/objects/volcanoplot.py +290 -0
- seer_pas_sdk-3.0.0.dist-info/METADATA +231 -0
- seer_pas_sdk-3.0.0.dist-info/RECORD +18 -0
- {seer_pas_sdk-0.1.3.dist-info → seer_pas_sdk-3.0.0.dist-info}/WHEEL +1 -1
- {seer_pas_sdk-0.1.3.dist-info → seer_pas_sdk-3.0.0.dist-info}/top_level.txt +0 -1
- seer_pas_sdk-0.1.3.dist-info/METADATA +0 -50
- seer_pas_sdk-0.1.3.dist-info/RECORD +0 -19
- tests/__init__.py +0 -0
- tests/conftest.py +0 -17
- tests/test_auth.py +0 -48
- tests/test_common.py +0 -99
- tests/test_objects.py +0 -91
- tests/test_sdk.py +0 -11
- {seer_pas_sdk-0.1.3.dist-info → seer_pas_sdk-3.0.0.dist-info/licenses}/LICENSE.txt +0 -0
seer_pas_sdk/objects/__init__.py
CHANGED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Filter group analysis data for only the POST
|
|
2
|
+
class GroupAnalysisPostData:
|
|
3
|
+
"""DTO for Group Analysis Saved Results"""
|
|
4
|
+
|
|
5
|
+
def __init__(self, data):
|
|
6
|
+
if "post" not in data:
|
|
7
|
+
raise ValueError('Invalid data format. Missing "post" key')
|
|
8
|
+
|
|
9
|
+
# Safe check if there are proteins vs peptides
|
|
10
|
+
num_proteins = (
|
|
11
|
+
data["post"]
|
|
12
|
+
.get("protein", {"totalFeature": 0})
|
|
13
|
+
.get("totalFeature", 0)
|
|
14
|
+
)
|
|
15
|
+
num_peptides = (
|
|
16
|
+
data["post"]
|
|
17
|
+
.get("peptide", {"totalFeature": 0})
|
|
18
|
+
.get("totalFeature", 0)
|
|
19
|
+
)
|
|
20
|
+
|
|
21
|
+
if num_proteins > 0:
|
|
22
|
+
self.type = "protein"
|
|
23
|
+
elif num_peptides > 0:
|
|
24
|
+
self.type = "peptide"
|
|
25
|
+
else:
|
|
26
|
+
raise ValueError(
|
|
27
|
+
"Invalid data format. No features found in post data"
|
|
28
|
+
)
|
|
29
|
+
self.data = data["post"][self.type]["mergedStats"]
|
|
30
|
+
self.stat_test = data["post"][self.type]["parameters"]["statTest"]
|
seer_pas_sdk/objects/platemap.py
CHANGED
|
@@ -21,10 +21,16 @@ class PlateMap:
|
|
|
21
21
|
sample_volume=None,
|
|
22
22
|
peptide_concentration=None,
|
|
23
23
|
peptide_mass_sample=None,
|
|
24
|
+
recon_volume=None,
|
|
24
25
|
dilution_factor=None,
|
|
25
26
|
kit_id=None,
|
|
26
27
|
plate_id=None,
|
|
27
28
|
plate_name=None,
|
|
29
|
+
assay_version=None,
|
|
30
|
+
sample_tube_id=None,
|
|
31
|
+
method_set_id=None,
|
|
32
|
+
assay_method_id=None,
|
|
33
|
+
product="XT",
|
|
28
34
|
):
|
|
29
35
|
|
|
30
36
|
if not ms_file_name:
|
|
@@ -45,30 +51,61 @@ class PlateMap:
|
|
|
45
51
|
self.sample_volume = sample_volume
|
|
46
52
|
self.peptide_concentration = peptide_concentration
|
|
47
53
|
self.peptide_mass_sample = peptide_mass_sample
|
|
54
|
+
self.recon_volume = recon_volume
|
|
48
55
|
self.dilution_factor = dilution_factor
|
|
49
56
|
self.kit_id = kit_id
|
|
50
57
|
self.plate_id = plate_id
|
|
51
58
|
self.plate_name = plate_name
|
|
52
|
-
|
|
53
|
-
self.
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
59
|
+
self.assay_version = assay_version
|
|
60
|
+
self.sample_tube_id = sample_tube_id
|
|
61
|
+
self.method_set_id = method_set_id
|
|
62
|
+
self.assay_method_id = assay_method_id
|
|
63
|
+
self.product = product
|
|
64
|
+
|
|
65
|
+
if self.product == "XT":
|
|
66
|
+
self.__map = {
|
|
67
|
+
"ms_file_name": "MS file name",
|
|
68
|
+
"sample_name": "Sample name",
|
|
69
|
+
"sample_id": "Sample ID",
|
|
70
|
+
"well_location": "Well location",
|
|
71
|
+
"nanoparticle": "Nanoparticle",
|
|
72
|
+
"nanoparticle_id": "Nanoparticle ID",
|
|
73
|
+
"control": "Control",
|
|
74
|
+
"control_id": "Control ID",
|
|
75
|
+
"instrument_name": "Instrument name",
|
|
76
|
+
"date_sample_preparation": "Date sample preparation",
|
|
77
|
+
"sample_volume": "Sample volume",
|
|
78
|
+
"peptide_concentration": "Peptide concentration",
|
|
79
|
+
"peptide_mass_sample": "Peptide mass sample",
|
|
80
|
+
"recon_volume": "Recon volume",
|
|
81
|
+
"dilution_factor": "Dilution factor",
|
|
82
|
+
"kit_id": "Kit ID",
|
|
83
|
+
"plate_id": "Plate ID",
|
|
84
|
+
"plate_name": "Plate Name",
|
|
85
|
+
"assay_version": "Assay",
|
|
86
|
+
}
|
|
87
|
+
else:
|
|
88
|
+
self.__map = {
|
|
89
|
+
"ms_file_name": "MS file name",
|
|
90
|
+
"sample_name": "Sample name",
|
|
91
|
+
"sample_id": "Sample ID",
|
|
92
|
+
"well_location": "Well location",
|
|
93
|
+
"nanoparticle": "Nanoparticle set",
|
|
94
|
+
"nanoparticle_id": "Nanoparticle set ID",
|
|
95
|
+
"control_id": "Control ID",
|
|
96
|
+
"instrument_name": "Instrument ID",
|
|
97
|
+
"date_sample_preparation": "Date assay initiated",
|
|
98
|
+
"sample_volume": "Sample volume",
|
|
99
|
+
"peptide_concentration": "Reconstituted peptide concentration",
|
|
100
|
+
"peptide_mass_sample": "Recovered peptide mass",
|
|
101
|
+
"recon_volume": "Reconstitution volume",
|
|
102
|
+
"plate_id": "Plate ID",
|
|
103
|
+
"plate_name": "Plate Name",
|
|
104
|
+
"assay_version": "Assay product",
|
|
105
|
+
"sample_tube_id": "Sample tube ID",
|
|
106
|
+
"method_set_id": "Method set ID",
|
|
107
|
+
"assay_method_id": "Assay method ID",
|
|
108
|
+
}
|
|
72
109
|
|
|
73
110
|
self.__attrs = [
|
|
74
111
|
"ms_file_name",
|
|
@@ -84,10 +121,15 @@ class PlateMap:
|
|
|
84
121
|
"sample_volume",
|
|
85
122
|
"peptide_concentration",
|
|
86
123
|
"peptide_mass_sample",
|
|
124
|
+
"recon_volume",
|
|
87
125
|
"dilution_factor",
|
|
88
126
|
"kit_id",
|
|
89
127
|
"plate_id",
|
|
90
128
|
"plate_name",
|
|
129
|
+
"assay_version",
|
|
130
|
+
"sample_tube_id",
|
|
131
|
+
"method_set_id",
|
|
132
|
+
"assay_method_id",
|
|
91
133
|
]
|
|
92
134
|
|
|
93
135
|
for attr in self.__attrs:
|
|
@@ -109,8 +151,11 @@ class PlateMap:
|
|
|
109
151
|
def to_dict(self):
|
|
110
152
|
res = {}
|
|
111
153
|
|
|
112
|
-
|
|
113
|
-
|
|
154
|
+
supported_cols = self.__map.keys()
|
|
155
|
+
|
|
156
|
+
for attr in self.__attrs:
|
|
157
|
+
if attr in supported_cols:
|
|
158
|
+
res[self.__map[attr]] = getattr(self, attr)
|
|
114
159
|
|
|
115
160
|
for entry in res:
|
|
116
161
|
res[entry] = {i: res[entry][i] for i in range(len(res[entry]))}
|
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
import numpy as np
|
|
2
|
+
import json
|
|
3
|
+
import pandas as pd
|
|
4
|
+
from typing import List as _List, Dict as _Dict
|
|
5
|
+
from .groupanalysis import GroupAnalysisPostData
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class VolcanoPlotSettings:
|
|
9
|
+
"""Class to hold the settings information for the Volcano Plot"""
|
|
10
|
+
|
|
11
|
+
def __init__(
|
|
12
|
+
self,
|
|
13
|
+
significance_threshold: float = 0.05,
|
|
14
|
+
fold_change_threshold: float = 1,
|
|
15
|
+
label_by: str = "fold_change",
|
|
16
|
+
):
|
|
17
|
+
"""Initialize the VolcanoPlotSettings object
|
|
18
|
+
|
|
19
|
+
Args:
|
|
20
|
+
significance_threshold (float, optional): Cutoff value for the p-value to determine significance. Defaults to 0.05.
|
|
21
|
+
fold_change_threshold (float, optional): Cutoff value for the fold change to determine significance. Defaults to 1.
|
|
22
|
+
label_by (str, optional): Metric to sort result data. Defaults to "fold_change".
|
|
23
|
+
|
|
24
|
+
Raises:
|
|
25
|
+
ValueError: "Invalid label_by value, must be one of ['euclidean', 'fold_change', 'significance']"
|
|
26
|
+
"""
|
|
27
|
+
if label_by not in ["euclidean", "fold_change", "significance"]:
|
|
28
|
+
raise ValueError(
|
|
29
|
+
"Invalid label_by value, must be one of ['euclidean', 'fold_change', 'significance']"
|
|
30
|
+
)
|
|
31
|
+
self.significance_threshold = significance_threshold
|
|
32
|
+
self.fold_change_threshold = fold_change_threshold
|
|
33
|
+
self.label_by = label_by
|
|
34
|
+
|
|
35
|
+
@property
|
|
36
|
+
def values(self):
|
|
37
|
+
return {
|
|
38
|
+
"significance_threshold": self.significance_threshold,
|
|
39
|
+
"fold_change_threshold": self.fold_change_threshold,
|
|
40
|
+
"label_by": self.label_by,
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
@classmethod
|
|
44
|
+
def get_settings(cls):
|
|
45
|
+
return [
|
|
46
|
+
"significance_threshold",
|
|
47
|
+
"fold_change_threshold",
|
|
48
|
+
"label_by",
|
|
49
|
+
]
|
|
50
|
+
|
|
51
|
+
@classmethod
|
|
52
|
+
def get_label_by_map(cls):
|
|
53
|
+
return dict(
|
|
54
|
+
euclidean="euclideanDistance",
|
|
55
|
+
fold_change="logFD",
|
|
56
|
+
significance="negativeLog10P",
|
|
57
|
+
)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
class VolcanoPlotBuilder:
|
|
61
|
+
"""
|
|
62
|
+
Builder class for the Volcano Plot
|
|
63
|
+
Can be used to reuse the same GroupAnalysisResults data to build multiple Volcano Plots with different settings.
|
|
64
|
+
|
|
65
|
+
"""
|
|
66
|
+
|
|
67
|
+
PROTEIN_GROUP_INDEX = "pg"
|
|
68
|
+
PEPTIDE_INDEX = "peptide"
|
|
69
|
+
|
|
70
|
+
def __init__(
|
|
71
|
+
self,
|
|
72
|
+
data: _List[_Dict],
|
|
73
|
+
significance_threshold: float = 0.05,
|
|
74
|
+
fold_change_threshold: float = 1,
|
|
75
|
+
label_by: str = "fold_change",
|
|
76
|
+
):
|
|
77
|
+
"""Initialize the VolcanoPlotBuilder object
|
|
78
|
+
|
|
79
|
+
Args:
|
|
80
|
+
data (list[dict]): The complete set of group analysis result data
|
|
81
|
+
significance_threshold (float, optional): Cutoff value for the p-value to determine significance. Defaults to 0.05.
|
|
82
|
+
fold_change_threshold (float, optional): Cutoff value for the fold change to determine significance. Defaults to 1.
|
|
83
|
+
label_by (str, optional): Metric to sort result data. Defaults to "fold_change".
|
|
84
|
+
|
|
85
|
+
Raises:
|
|
86
|
+
ValueError: "Invalid label_by value, must be one of ['euclidean', 'fold_change', 'significance']"
|
|
87
|
+
|
|
88
|
+
Returns:
|
|
89
|
+
None
|
|
90
|
+
"""
|
|
91
|
+
|
|
92
|
+
self.settings = VolcanoPlotSettings(
|
|
93
|
+
significance_threshold=significance_threshold,
|
|
94
|
+
fold_change_threshold=fold_change_threshold,
|
|
95
|
+
label_by=label_by,
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
parsed_data = GroupAnalysisPostData(data)
|
|
99
|
+
|
|
100
|
+
self.type = parsed_data.type
|
|
101
|
+
self.stat_test = parsed_data.stat_test
|
|
102
|
+
self.data = parsed_data.data
|
|
103
|
+
self.minusLog10PSigValue = -np.log10(
|
|
104
|
+
self.settings.significance_threshold
|
|
105
|
+
)
|
|
106
|
+
self.sort_param = VolcanoPlotSettings.get_label_by_map()[
|
|
107
|
+
self.settings.label_by
|
|
108
|
+
]
|
|
109
|
+
self.max_logFD, self.max_negative_log10_p = self._get_max_values(
|
|
110
|
+
self.data
|
|
111
|
+
)
|
|
112
|
+
self.protein_gene_map = dict()
|
|
113
|
+
self.feature_type_index = (
|
|
114
|
+
self.PROTEIN_GROUP_INDEX
|
|
115
|
+
if self.type == "protein"
|
|
116
|
+
else self.PEPTIDE_INDEX
|
|
117
|
+
)
|
|
118
|
+
self.volcano_plot = self.build()
|
|
119
|
+
|
|
120
|
+
def build(self):
|
|
121
|
+
"""Build the volcano plot
|
|
122
|
+
|
|
123
|
+
Returns:
|
|
124
|
+
list[dict]: sorted volcano plot data
|
|
125
|
+
"""
|
|
126
|
+
result = []
|
|
127
|
+
for i, row in enumerate(self.data):
|
|
128
|
+
result.append(self.build_row(i, row))
|
|
129
|
+
sorted_result = sorted(
|
|
130
|
+
result,
|
|
131
|
+
key=lambda x: (
|
|
132
|
+
x[self.sort_param]
|
|
133
|
+
if self.sort_param != "logFD"
|
|
134
|
+
else np.abs(x[self.sort_param])
|
|
135
|
+
),
|
|
136
|
+
reverse=True,
|
|
137
|
+
)
|
|
138
|
+
return sorted_result
|
|
139
|
+
|
|
140
|
+
def build_row(self, i, data):
|
|
141
|
+
"""Build a row for the volcano plot
|
|
142
|
+
|
|
143
|
+
Args:
|
|
144
|
+
i (int): The index of the row
|
|
145
|
+
data (dict): a group analysis result entry
|
|
146
|
+
|
|
147
|
+
Returns:
|
|
148
|
+
dict: The row data
|
|
149
|
+
"""
|
|
150
|
+
self.protein_gene_map[data[self.feature_type_index]] = data["gene"]
|
|
151
|
+
|
|
152
|
+
row = dict(
|
|
153
|
+
logFD=data["logFD"],
|
|
154
|
+
negativeLog10P=data["negativeLog10P"],
|
|
155
|
+
dataIndex=i,
|
|
156
|
+
rowID=json.dumps(data),
|
|
157
|
+
gene=data["gene"],
|
|
158
|
+
group=self.get_contrast_group_string(data),
|
|
159
|
+
significant=self.get_significance_class(data),
|
|
160
|
+
euclideanDistance=self.calculate_euclidean_distance(
|
|
161
|
+
data["logFD"] / self.max_logFD,
|
|
162
|
+
data["negativeLog10P"] / self.max_negative_log10_p,
|
|
163
|
+
),
|
|
164
|
+
)
|
|
165
|
+
row[self.type] = data[self.feature_type_index]
|
|
166
|
+
return row
|
|
167
|
+
|
|
168
|
+
def is_significant_point(self, data):
|
|
169
|
+
return (
|
|
170
|
+
data["negativeLog10P"] >= self.minusLog10PSigValue
|
|
171
|
+
and np.abs(data["logFD"]) >= self.settings.fold_change_threshold
|
|
172
|
+
)
|
|
173
|
+
|
|
174
|
+
def get_significance_class(self, data):
|
|
175
|
+
"""Get the significance class
|
|
176
|
+
|
|
177
|
+
Args:
|
|
178
|
+
data (dict): the row data
|
|
179
|
+
|
|
180
|
+
Returns:
|
|
181
|
+
int: 0 if not significant, 1 if (logFD >= 1), -1 if (logFD <= -1)
|
|
182
|
+
"""
|
|
183
|
+
if not self.is_significant_point(data):
|
|
184
|
+
return 0
|
|
185
|
+
elif data["logFD"] >= 1:
|
|
186
|
+
return 1
|
|
187
|
+
elif data["logFD"] <= -1:
|
|
188
|
+
return -1
|
|
189
|
+
|
|
190
|
+
def get_contrast_group_string(self, obj):
|
|
191
|
+
"""Get the contrast group string
|
|
192
|
+
|
|
193
|
+
Args:
|
|
194
|
+
obj (dict): The row data
|
|
195
|
+
|
|
196
|
+
Returns:
|
|
197
|
+
str: The contrast group string
|
|
198
|
+
"""
|
|
199
|
+
if (
|
|
200
|
+
obj
|
|
201
|
+
and obj.get("contrastGroup", None)
|
|
202
|
+
and obj["contrastGroup"].get("G1", None)
|
|
203
|
+
and obj["contrastGroup"].get("G2", None)
|
|
204
|
+
):
|
|
205
|
+
return "/".join(
|
|
206
|
+
[obj["contrastGroup"]["G1"], obj["contrastGroup"]["G2"]]
|
|
207
|
+
)
|
|
208
|
+
|
|
209
|
+
def calculate_euclidean_distance(self, x, y):
|
|
210
|
+
"""Calculate the euclidean distance
|
|
211
|
+
|
|
212
|
+
Args:
|
|
213
|
+
x (float): The x value
|
|
214
|
+
y (float): The y value
|
|
215
|
+
|
|
216
|
+
Returns:
|
|
217
|
+
float: The euclidean distance
|
|
218
|
+
"""
|
|
219
|
+
return np.sqrt(x**2 + y**2)
|
|
220
|
+
|
|
221
|
+
def _get_max_values(self, data):
|
|
222
|
+
"""For euclidean distance, get the max logFD and negativeLog10P values to normalize the data
|
|
223
|
+
|
|
224
|
+
Args:
|
|
225
|
+
data (list[dict]): The complete set of group analysis result data
|
|
226
|
+
|
|
227
|
+
Returns:
|
|
228
|
+
tuple: The max logFD and negativeLog10P values.
|
|
229
|
+
"""
|
|
230
|
+
max_logFD = -np.inf
|
|
231
|
+
max_negative_log10_p = -np.inf
|
|
232
|
+
for row in data:
|
|
233
|
+
max_logFD = max(max_logFD, row["logFD"])
|
|
234
|
+
max_negative_log10_p = max(
|
|
235
|
+
max_negative_log10_p, row["negativeLog10P"]
|
|
236
|
+
)
|
|
237
|
+
return max_logFD, max_negative_log10_p
|
|
238
|
+
|
|
239
|
+
def update(
|
|
240
|
+
self,
|
|
241
|
+
significance_threshold=None,
|
|
242
|
+
fold_change_threshold=None,
|
|
243
|
+
label_by=None,
|
|
244
|
+
):
|
|
245
|
+
"""Updates the settings and recalculates the volcano plot
|
|
246
|
+
|
|
247
|
+
Args:
|
|
248
|
+
significance_threshold (float, optional): Cutoff value for the p-value to determine significance
|
|
249
|
+
fold_change_threshold (float, optional): Cutoff value for the fold change to determine significance
|
|
250
|
+
label_by (str, optional): Metric to sort result data
|
|
251
|
+
|
|
252
|
+
Raises:
|
|
253
|
+
ValueError: "Invalid label_by value, must be one of ['euclidean', 'fold_change', 'significance']"
|
|
254
|
+
|
|
255
|
+
Returns:
|
|
256
|
+
None
|
|
257
|
+
"""
|
|
258
|
+
if not significance_threshold:
|
|
259
|
+
significance_threshold = self.settings.significance_threshold
|
|
260
|
+
if not fold_change_threshold:
|
|
261
|
+
fold_change_threshold = self.settings.fold_change_threshold
|
|
262
|
+
if not label_by:
|
|
263
|
+
label_by = self.settings.label_by
|
|
264
|
+
|
|
265
|
+
self.settings = VolcanoPlotSettings(
|
|
266
|
+
significance_threshold=significance_threshold,
|
|
267
|
+
fold_change_threshold=fold_change_threshold,
|
|
268
|
+
label_by=label_by,
|
|
269
|
+
)
|
|
270
|
+
self.minusLog10PSigValue = -np.log10(
|
|
271
|
+
self.settings.significance_threshold
|
|
272
|
+
)
|
|
273
|
+
self.sort_param = VolcanoPlotSettings.get_label_by_map()[
|
|
274
|
+
self.settings.label_by
|
|
275
|
+
]
|
|
276
|
+
self.volcano_plot = self.build()
|
|
277
|
+
|
|
278
|
+
def to_df(self):
|
|
279
|
+
"""Convert the volcano plot data to a DataFrame"""
|
|
280
|
+
return pd.DataFrame(self.volcano_plot)
|
|
281
|
+
|
|
282
|
+
def get_significant_rows(self):
|
|
283
|
+
"""Get the significant proteins
|
|
284
|
+
|
|
285
|
+
Returns:
|
|
286
|
+
List: The list of significant proteins
|
|
287
|
+
"""
|
|
288
|
+
return [
|
|
289
|
+
row[self.type] for row in self.volcano_plot if row["significant"]
|
|
290
|
+
]
|
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: seer-pas-sdk
|
|
3
|
+
Version: 3.0.0
|
|
4
|
+
Summary: SDK for Seer Proteograph Analysis Suite (PAS)
|
|
5
|
+
Author-email: Ryan Sun <rsun@seer.bio>
|
|
6
|
+
License:
|
|
7
|
+
Apache License
|
|
8
|
+
Version 2.0, January 2004
|
|
9
|
+
http://www.apache.org/licenses/
|
|
10
|
+
|
|
11
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
12
|
+
|
|
13
|
+
1. Definitions.
|
|
14
|
+
|
|
15
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
16
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
17
|
+
|
|
18
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
19
|
+
the copyright owner that is granting the License.
|
|
20
|
+
|
|
21
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
22
|
+
other entities that control, are controlled by, or are under common
|
|
23
|
+
control with that entity. For the purposes of this definition,
|
|
24
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
25
|
+
direction or management of such entity, whether by contract or
|
|
26
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
27
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
28
|
+
|
|
29
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
30
|
+
exercising permissions granted by this License.
|
|
31
|
+
|
|
32
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
33
|
+
including but not limited to software source code, documentation
|
|
34
|
+
source, and configuration files.
|
|
35
|
+
|
|
36
|
+
"Object" form shall mean any form resulting from mechanical
|
|
37
|
+
transformation or translation of a Source form, including but
|
|
38
|
+
not limited to compiled object code, generated documentation,
|
|
39
|
+
and conversions to other media types.
|
|
40
|
+
|
|
41
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
42
|
+
Object form, made available under the License, as indicated by a
|
|
43
|
+
copyright notice that is included in or attached to the work
|
|
44
|
+
(an example is provided in the Appendix below).
|
|
45
|
+
|
|
46
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
47
|
+
form, that is based on (or derived from) the Work and for which the
|
|
48
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
49
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
50
|
+
of this License, Derivative Works shall not include works that remain
|
|
51
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
52
|
+
the Work and Derivative Works thereof.
|
|
53
|
+
|
|
54
|
+
"Contribution" shall mean any work of authorship, including
|
|
55
|
+
the original version of the Work and any modifications or additions
|
|
56
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
57
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
58
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
59
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
60
|
+
means any form of electronic, verbal, or written communication sent
|
|
61
|
+
to the Licensor or its representatives, including but not limited to
|
|
62
|
+
communication on electronic mailing lists, source code control systems,
|
|
63
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
64
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
65
|
+
excluding communication that is conspicuously marked or otherwise
|
|
66
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
67
|
+
|
|
68
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
69
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
70
|
+
subsequently incorporated within the Work.
|
|
71
|
+
|
|
72
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
73
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
74
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
75
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
76
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
77
|
+
Work and such Derivative Works in Source or Object form.
|
|
78
|
+
|
|
79
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
80
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
81
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
82
|
+
(except as stated in this section) patent license to make, have made,
|
|
83
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
84
|
+
where such license applies only to those patent claims licensable
|
|
85
|
+
by such Contributor that are necessarily infringed by their
|
|
86
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
87
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
88
|
+
institute patent litigation against any entity (including a
|
|
89
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
90
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
91
|
+
or contributory patent infringement, then any patent licenses
|
|
92
|
+
granted to You under this License for that Work shall terminate
|
|
93
|
+
as of the date such litigation is filed.
|
|
94
|
+
|
|
95
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
96
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
97
|
+
modifications, and in Source or Object form, provided that You
|
|
98
|
+
meet the following conditions:
|
|
99
|
+
|
|
100
|
+
(a) You must give any other recipients of the Work or
|
|
101
|
+
Derivative Works a copy of this License; and
|
|
102
|
+
|
|
103
|
+
(b) You must cause any modified files to carry prominent notices
|
|
104
|
+
stating that You changed the files; and
|
|
105
|
+
|
|
106
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
107
|
+
that You distribute, all copyright, patent, trademark, and
|
|
108
|
+
attribution notices from the Source form of the Work,
|
|
109
|
+
excluding those notices that do not pertain to any part of
|
|
110
|
+
the Derivative Works; and
|
|
111
|
+
|
|
112
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
113
|
+
distribution, then any Derivative Works that You distribute must
|
|
114
|
+
include a readable copy of the attribution notices contained
|
|
115
|
+
within such NOTICE file, excluding those notices that do not
|
|
116
|
+
pertain to any part of the Derivative Works, in at least one
|
|
117
|
+
of the following places: within a NOTICE text file distributed
|
|
118
|
+
as part of the Derivative Works; within the Source form or
|
|
119
|
+
documentation, if provided along with the Derivative Works; or,
|
|
120
|
+
within a display generated by the Derivative Works, if and
|
|
121
|
+
wherever such third-party notices normally appear. The contents
|
|
122
|
+
of the NOTICE file are for informational purposes only and
|
|
123
|
+
do not modify the License. You may add Your own attribution
|
|
124
|
+
notices within Derivative Works that You distribute, alongside
|
|
125
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
126
|
+
that such additional attribution notices cannot be construed
|
|
127
|
+
as modifying the License.
|
|
128
|
+
|
|
129
|
+
You may add Your own copyright statement to Your modifications and
|
|
130
|
+
may provide additional or different license terms and conditions
|
|
131
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
132
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
133
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
134
|
+
the conditions stated in this License.
|
|
135
|
+
|
|
136
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
137
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
138
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
139
|
+
this License, without any additional terms or conditions.
|
|
140
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
141
|
+
the terms of any separate license agreement you may have executed
|
|
142
|
+
with Licensor regarding such Contributions.
|
|
143
|
+
|
|
144
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
145
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
146
|
+
except as required for reasonable and customary use in describing the
|
|
147
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
148
|
+
|
|
149
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
150
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
151
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
152
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
153
|
+
implied, including, without limitation, any warranties or conditions
|
|
154
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
155
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
156
|
+
appropriateness of using or redistributing the Work and assume any
|
|
157
|
+
risks associated with Your exercise of permissions under this License.
|
|
158
|
+
|
|
159
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
160
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
161
|
+
unless required by applicable law (such as deliberate and grossly
|
|
162
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
163
|
+
liable to You for damages, including any direct, indirect, special,
|
|
164
|
+
incidental, or consequential damages of any character arising as a
|
|
165
|
+
result of this License or out of the use or inability to use the
|
|
166
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
167
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
168
|
+
other commercial damages or losses), even if such Contributor
|
|
169
|
+
has been advised of the possibility of such damages.
|
|
170
|
+
|
|
171
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
172
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
173
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
174
|
+
or other liability obligations and/or rights consistent with this
|
|
175
|
+
License. However, in accepting such obligations, You may act only
|
|
176
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
177
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
178
|
+
defend, and hold each Contributor harmless for any liability
|
|
179
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
180
|
+
of your accepting any such warranty or additional liability.
|
|
181
|
+
|
|
182
|
+
END OF TERMS AND CONDITIONS
|
|
183
|
+
|
|
184
|
+
Project-URL: Issues, https://github.com/seerbio/seer-pas-sdk/issues
|
|
185
|
+
Keywords: seer,sdk,pas,mass spectrometry,proteomics
|
|
186
|
+
Classifier: Development Status :: 4 - Beta
|
|
187
|
+
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
|
|
188
|
+
Classifier: Operating System :: OS Independent
|
|
189
|
+
Classifier: Programming Language :: Python :: 3
|
|
190
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
191
|
+
Requires-Python: >=3.8
|
|
192
|
+
Description-Content-Type: text/markdown
|
|
193
|
+
License-File: LICENSE.txt
|
|
194
|
+
Requires-Dist: boto3>=1.26.152
|
|
195
|
+
Requires-Dist: botocore>=1.29.152
|
|
196
|
+
Requires-Dist: pandas>=2.0.1
|
|
197
|
+
Requires-Dist: numpy<2.0.0,>=1.5.3
|
|
198
|
+
Requires-Dist: PyJWT>=2.8.0
|
|
199
|
+
Requires-Dist: python-dotenv>=1.0.0
|
|
200
|
+
Requires-Dist: Requests>=2.31.0
|
|
201
|
+
Requires-Dist: tqdm>=4.65.0
|
|
202
|
+
Requires-Dist: deprecation
|
|
203
|
+
Dynamic: license-file
|
|
204
|
+
|
|
205
|
+
# Seer PAS Python SDK
|
|
206
|
+
|
|
207
|
+
[](https://github.com/seerbio/seer-pas-sdk/actions/workflows/test.yml)
|
|
208
|
+
[](https://github.com/seerbio/seer-pas-sdk/actions/workflows/lint.yml)
|
|
209
|
+
|
|
210
|
+
This SDK permits interaction with the Seer Proteograph Analysis Suite using Python.
|
|
211
|
+
|
|
212
|
+
## Installation
|
|
213
|
+
|
|
214
|
+
```shell
|
|
215
|
+
pip install seer-pas-sdk
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
## Usage
|
|
219
|
+
|
|
220
|
+
To import and set up the SDK:
|
|
221
|
+
|
|
222
|
+
```python
|
|
223
|
+
from seer_pas_sdk import SeerSDK
|
|
224
|
+
|
|
225
|
+
# Instantiate an SDK object with your credentials:
|
|
226
|
+
sdk = SeerSDK(USERNAME, PASSWORD)
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
You can then use the SDK's methods to create, query, or retrieve projects, plates, samples, and analyses.
|
|
230
|
+
|
|
231
|
+
For complete documentation of this SDK, visit [https://seerbio.github.io/seer-pas-sdk/](https://seerbio.github.io/seer-pas-sdk/ "Documentation").
|