Cytoturing SDK Overview - 0.1.0

Welcome to Cytoturing SDK.
Cytoturing, the SDK for FCS file provides an automated way to run your analysis.

Prerequisites

Python 3.8.10 or newer.

Features

User authentication

get_access_token(email, password)

Args:
     email (str): email of the user.
     password (str): password of the user.
Returns:
     access_token (str): access token of the user.

Uploading fcs file

upload_file(access_token, file)

Args:
     access_token (str): access token of the user.
     file (str): path and file name of the file you want to upload.
Returns:
     file id (dict): unique id of the file you uploaded.

Prediction

run_predict(access_token, file_ids)

Args:
     access_token (str): access token of the user.
     file ids (list): list of file ids in a sample.
Returns:
     analysis id (str): prediction result of a target sample.

Getting result

get_result(access_token, analysis_id)

Args:
     access_token (str): access token of the user.
     analysis_id (str): id of a sample prediction.
Returns:
     result (dict): prediction result of a target sample.