def update(self):
"""
Fetches the most up-to-date version of the entity from Labstep.
"""
from labstep.generic.entity.repository import entityRepository
data = entityRepository.getEntity(
self.__user__, type(self), self.id).__data__
self.__init__(data, self.__user__)
return self
def getEntry(self):
"""
Returns a JSON document representing the entry for the experiment.
Example
-------
::
my_experiment = user.getExperiment(17000)
print(my_experiment.getEntry())
"""
from labstep.generic.entity.repository import entityRepository
return entityRepository.getEntity(self.__user__, ExperimentProtocol,
self.root_experiment.id).state
def getResourceCategory(self, user, resourceCategory_id):
"""
Retrieve a specific Labstep ResourceCategory.
Parameters
----------
user (obj)
The Labstep user. Must have property
'api_key'. See 'login'.
resourceCategory_id (int)
The id of the ResourceCategory to retrieve.
Returns
-------
ResourceCategory
An object representing a Labstep ResourceCategory.
"""
return entityRepository.getEntity(user,
ResourceCategory,
id=resourceCategory_id)
def getExperimentMaterial(self, user, experiment_material_id):
return entityRepository.getEntity(user,
ExperimentMaterial,
id=experiment_material_id)
def getProtocol(self, user, protocol_id):
return entityRepository.getEntity(user, Protocol, id=protocol_id)
def getResourceItem(self, user, resourceItem_id):
return entityRepository.getEntity(user,
ResourceItem,
id=resourceItem_id)
def getJupyterInstance(self, user, guid):
return entityRepository.getEntity(user, JupyterInstance, id=guid)
def getExperiment(self, user, id):
return entityRepository.getEntity(user, Experiment, id=id)
def getResourceLocation(self, user, resource_location_id):
return entityRepository.getEntity(
user, ResourceLocation, id=resource_location_id
)
def getWorkspace(self, user, workspace_id):
return entityRepository.getEntity(user, Workspace, id=workspace_id)
def getFile(self, user, fileId):
return entityRepository.getEntity(user, File, fileId, isDeleted=None)
def getDevice(self, user, device_id):
return entityRepository.getEntity(user, Device, id=device_id)
def getJupyterNotebook(self, user, guid):
return entityRepository.getEntity(user, JupyterNotebook, id=guid)
def getOrganization(self, user, id, extraParams={}):
return entityRepository.getEntity(user, Organization, id, extraParams)
def getOrderRequest(self, user, orderRequest_id):
return entityRepository.getEntity(user,
OrderRequest,
id=orderRequest_id)
