nextpyp.client.gen#

Functions

none_map

map the None value in the optional type, so we can avoid using intermediate variables and simplify the code generator

none_raise

if the optional type is None, raise the exception created by the lambda (because apparently Python doesn't allow lambdas consisting only of raise statements), so we can avoid using intermediate variables and simplify the code generator

option_unwrap

rtype:

Optional[Any]

optional_map

map the optional type, so we can avoid using intermediate variables and simplify the code generator

Classes

AppPermissionData

(no description yet)

AppTokenRequestData

(no description yet)

AppsService

Service providing functions specific to apps, mainly requesting and managing app tokens

AvgRotData

(no description yet)

Block

(no description yet)

ClusterJobData

(no description yet)

ClusterJobDataArrayInfo

(no description yet)

ClusterJobResultType

(no description yet)

CtfTiltValues

(no description yet)

DriftMetadata

(no description yet)

DriftXY

(no description yet)

Group

Represents a group of users (usually an academic lab)

ImageDims

(no description yet)

ImagesScale

A way to represent the physical size of things in micrograph and tomogram images.

JobArgs

Argument storage for jobs.

JobRunData

(no description yet)

MicrographMetadata

(no description yet)

MotionData

(no description yet)

PreprocessingFilter

(no description yet)

PreprocessingPropRange

(no description yet)

ProjectData

(no description yet)

ProjectPermission

(no description yet)

ProjectRealtimeServiceConnection

(no description yet)

ProjectRunData

(no description yet)

ProjectsService

Service for interacting with user projects

PypStats

(no description yet)

RealTimeC2S

client-to-server (C2S) messages for real-time communication

RealTimeC2SListenToProject

(no description yet)

RealTimeC2SListenToSession

(no description yet)

RealTimeC2SSessionSettingsSaved

(no description yet)

RealTimeS2C

server-to-client (S2C) messages for real-time communication

RealTimeS2CClusterJobArrayEnd

(no description yet)

RealTimeS2CClusterJobArrayStart

(no description yet)

RealTimeS2CClusterJobEnd

(no description yet)

RealTimeS2CClusterJobStart

(no description yet)

RealTimeS2CClusterJobSubmit

(no description yet)

RealTimeS2CError

(no description yet)

RealTimeS2CJobFinish

(no description yet)

RealTimeS2CJobStart

(no description yet)

RealTimeS2CJobUpdate

(no description yet)

RealTimeS2CProjectRunFinish

(no description yet)

RealTimeS2CProjectRunInit

(no description yet)

RealTimeS2CProjectRunStart

(no description yet)

RealTimeS2CProjectStatus

(no description yet)

RealTimeS2CSessionDaemonFinished

(no description yet)

RealTimeS2CSessionDaemonStarted

(no description yet)

RealTimeS2CSessionDaemonSubmitted

(no description yet)

RealTimeS2CSessionExport

(no description yet)

RealTimeS2CSessionFilesystem

(no description yet)

RealTimeS2CSessionFilesystems

(no description yet)

RealTimeS2CSessionJobFinished

(no description yet)

RealTimeS2CSessionJobStarted

(no description yet)

RealTimeS2CSessionJobSubmitted

(no description yet)

RealTimeS2CSessionLargeData

(no description yet)

RealTimeS2CSessionMicrograph

(no description yet)

RealTimeS2CSessionRunningJob

(no description yet)

RealTimeS2CSessionSmallData

(no description yet)

RealTimeS2CSessionStatus

(no description yet)

RealTimeS2CSessionTiltSeries

(no description yet)

RealTimeS2CSessionTransferFinished

(no description yet)

RealTimeS2CSessionTransferInit

(no description yet)

RealTimeS2CSessionTransferInitFileInfo

(no description yet)

RealTimeS2CSessionTransferProgress

(no description yet)

RealTimeS2CSessionTransferStarted

(no description yet)

RealTimeS2CSessionTransferWaiting

(no description yet)

RealTimeS2CSessionTwoDClasses

(no description yet)

RealTimeS2CUpdatedParameters

(no description yet)

RealtimeServices

All of the different realtime services that can be accessed by the NextPYP client

ReconstructionData

(no description yet)

RefinementBundleData

(no description yet)

RefinementData

(no description yet)

RemoteOption

Search result option, with some options for presentation

RunStatus

(no description yet)

RunningSessions

because polymorphic serialization in KVision is too much of a pain

Services

This class houses all of the different regular services that can be accessed by the NextPYP client, with each service exposed as a class attribute.

SessionCommands

(no description yet)

SessionDaemon

(no description yet)

SessionExportData

(no description yet)

SessionExportRequest

WARNING: be very careful changing these classes! They get saved in the sessionExports database in serialized form, so deserializing old data could cause problems depending on how backwards compatible kotlinx.serialization is.

SessionExportRequestFilter

(no description yet)

SessionExportResult

WARNING: be very careful changing these classes! They get saved in the sessionExports database in serialized form, so deserializing old data could cause problems depending on how backwards compatible kotlinx.serialization is.

SessionExportResultCanceled

(no description yet)

SessionExportResultFailed

(no description yet)

SessionExportResultSucceeded

(no description yet)

SessionExportResultSucceededOutput

(no description yet)

SessionExportResultSucceededOutputFilter

(no description yet)

SessionJobLog

(no description yet)

SessionJobLogData

(no description yet)

SessionJobLogs

(no description yet)

SessionJobsLogs

(no description yet)

SessionLog

(no description yet)

SessionLogData

(no description yet)

SessionLogs

(no description yet)

SessionPermission

(no description yet)

SessionSpeeds

(no description yet)

SessionsService

(no description yet)

SingleParticleSessionArgs

(no description yet)

SingleParticleSessionData

(no description yet)

SingleParticleSessionDisplay

(no description yet)

SingleParticleSessionRealtimeServiceConnection

(no description yet)

SingleParticleSessionsService

(no description yet)

StreamLogMsg

(no description yet)

TiltSeriesData

(no description yet)

TomoVirMethod

(no description yet)

TomographySessionArgs

(no description yet)

TomographySessionData

(no description yet)

TomographySessionDisplay

(no description yet)

TomographySessionRealtimeServiceConnection

(no description yet)

TomographySessionsService

(no description yet)

TwoDClassesData

(no description yet)

UserData

(no description yet)

VersionData

(no description yet)