PM-API

Welcome to the PlayMolecule Python API documentation!

• Installation
  • Miniconda installation
  • Create conda environment
  • Install playmolecule python api package
• Tutorials
  • Contents
    • Basics
    • PlayMolecule DataCenter
    • App pipeline example on Adaptive Sampling
• The Session class
  • Session
    • Session.cancel_job()
    • Session.change_password()
    • Session.delete_job()
    • Session.describe_app()
    • Session.get_apps()
    • Session.get_job()
    • Session.get_jobs()
    • Session.get_service_status()
    • Session.login()
    • Session.register()
    • Session.retrieve_jobs()
    • Session.set_job_status()
    • Session.start_app()
    • Session.wait_for_backend()
  • SessionError
  • UserFailedRegistrationError
  • UserNotFoundError
  • UserUpdateError
  • fg
    • fg.black
    • fg.blue
    • fg.cyan
    • fg.end
    • fg.green
    • fg.magenta
    • fg.red
    • fg.rgb()
    • fg.white
    • fg.yellow
• The Job class
  • Job
    • Job.cancel()
    • Job.describe()
    • Job.get_children()
    • Job.get_error_info()
    • Job.get_progress()
    • Job.get_status()
    • Job.read_arguments()
    • Job.retrieve()
    • Job.submit()
    • Job.wait()
    • Job.wait_children()
    • Job.write_arguments()
  • JobBucketNotFoundError
  • JobConfigNotLoadedError
  • JobError
  • JobStatus
    • JobStatus.COMPLETED
    • JobStatus.ERROR
    • JobStatus.QUEUED
    • JobStatus.RUNNING
    • JobStatus.SLEEPING
    • JobStatus.VALIDATING
    • JobStatus.WAITING_APPROVAL
    • JobStatus.WAITING_DATA
    • JobStatus.describe()
  • StringOrDataset
    • StringOrDataset.validate()
  • short_execid()
• The DataCenter class
  • DataCenter
    • DataCenter.download_dataset()
    • DataCenter.get_dataset_tags()
    • DataCenter.get_datasets()
    • DataCenter.remove_dataset()
    • DataCenter.remove_dataset_tag()
    • DataCenter.upload_dataset()
  • DataCenterError
  • Dataset
    • Dataset.download()
    • Dataset.identifier
    • Dataset.list_files()
    • Dataset.move()
    • Dataset.remove()
    • Dataset.remove_tags()
    • Dataset.subset()
    • Dataset.update()
    • Dataset.update_comments()
  • download_dataset()
  • get_datasets()
  • move_dataset()
  • remove_dataset()
  • update_dataset_comments()
• Dev Only: PlayMolecule Dev Tools
  • app_arg_parser()
  • app_arg_parser2()
  • app_wrapper()
  • app_wrapper2()
  • basenameInputs()
  • getJobId()
  • pmtryexcept()
  • pmws_wrapper()
  • report_alive()
  • setAsCompleted()
  • setAsError()
  • setAsSleep()
  • tarFolder()
  • unzipit()
  • writeInputsOptionsLog()
  • writeInputsOptionsLog2()
  • writeSentinel()
  • zipdir()
  • zipit()
• API
  • Submodules
    • playmolecule.config module
    • playmolecule.datacenter module
    • playmolecule.devutils module
    • playmolecule.job module
    • playmolecule.jsonlogger module
    • playmolecule.local module
    • playmolecule.playqueue module
    • playmolecule.session module
    • playmolecule.utils module
  • Module contents
    • version()

Indices and tables

• Index

• Module Index

• Search Page