A Python interface for the CellEngine API that enables you to securely, reproducibly and easily interact with your data from a Python or Jupyter environment.
Please refer to Python Toolkit Documentation and CellEngine API Documentation for more information.
v1.0.0 will be the first stable release of the CellEngine Python Toolkit.
-
path
property removed. Previously, all classes had apath
property that was the URL of the resource. This conflicted with thepath
property of Folders and Experiments. -
FcsFile.header
is now a dict. Previously this was a JSON string. For convenience, it's now pre-parsed into a dict. -
Events DataFrames now consistently use a multi-level index with the first level being the channel name and the second level being the reagent name. This applies to the return values of
FcsFile.get_events()
,Compensation.apply()
andScaleSet.apply()
. -
Experiment.get_statistics()
return type defaults to DataFrame. Previously it was a dict. -
Cls.from_dict()
andCls.to_dict()
have been removed. These were meant for internal use and are no longer necessary. -
RangeGate
,RectangleGate
,PolygonGate
andEllipseGate
now inherit fromSimpleGate
, andQuadrantGate
andSplitGate
now inherit fromCompoundGate
. This means that simple gates no longer have anames
property and compound gates no longer have aname
property. -
Experiment.scalesets
is nowExperiment.scaleset
andExperiment.get_scaleset()
takes no args. There is only one ScaleSet in an experiment, so passing an_id
or name is unnecessary.
- Most dependencies have been removed.
- MyPy types have been significantly improved.
- Support for
Experiment.path
property was added. - Support for
compensation
in theExperiment.plot()
method was added. Cls.update()
now only sends changed values to CellEngine. This reduces the permissions required for some operations.- All tests now run against a real CellEngine instance instead of using mocks, avoiding bugs due to stale mocks.
- Support for
experiment.save_revision()
.