Contents

• Introduction
• Installation
• Examples
  • General Usage
    • Setting up the client
  • Catalog
    • Listing Applications
    • Listing Queues
    • Listing Desktop Types
  • Jobs
    • Listing Jobs
    • Checking job logs
    • Fetching job residuals
    • Submitting Jobs
    • OpenFOAM
    • zCFD
  • Job Arrays
  • Data
    • Listing a folder
    • Downloading a file
    • Uploading a file
    • Copying whole folders/directories
    • Deleting files or folders
  • Desktops
    • Listing Desktop Instances
    • Getting a quote for a Desktop
    • Launching a desktop
    • Terminating a desktop
  • Teams
  • Projects
    • Listing Projects
    • Setting active projects on jobs
• FAQ
  • Where do I get a token from?
  • What about uploading/downloading data?
• pyepic
  • pyepic package
    • Subpackages
      • pyepic.applications package
        • Submodules
        • pyepic.applications.base module
          • Config
            • Config.get_configuration()
          • Distribution
            • Distribution.CORE
            • Distribution.DEVICE
            • Distribution.NODE
            • Distribution.SOCKET
          • Job
            • Job.add_step()
            • Job.get_job_create_spec()
            • Job.get_job_spec()
          • JobArray
            • JobArray.add_job()
            • JobArray.get_job_create_spec()
          • JobStep
            • JobStep.get_task_spec()
          • Upload
            • Upload.NO
            • Upload.ON_ERROR
            • Upload.YES
        • pyepic.applications.openfoam module
          • BlockMeshStep
          • DecomposeParStep
          • OpenFoamJob
            • OpenFoamJob.get_applications_options()
            • OpenFoamJob.get_job_create_spec()
          • Reconstruct
            • Reconstruct.ALL
            • Reconstruct.LATEST
            • Reconstruct.TIME
          • ReconstructParStep
          • SolverStep
          • StartFrom
            • StartFrom.FIRST
            • StartFrom.LATEST
            • StartFrom.START
          • StopAt
            • StopAt.END_TIME
            • StopAt.NEXT_WRITE
            • StopAt.NO_WRITE_NOW
            • StopAt.WRITE_NOW
        • pyepic.applications.zcfd module
          • ZCFDJob
            • ZCFDJob.get_applications_options()
            • ZCFDJob.get_job_create_spec()
          • ZCFDStep
        • pyepic.applications.msc_nastran module
          • NastranJob
            • NastranJob.get_applications_options()
            • NastranJob.get_job_create_spec()
          • NastranStep
        • Module contents
      • pyepic.client package
        • Submodules
        • pyepic.client.base module
          • Client
            • Client.set_limt()
          • EPICClient
        • pyepic.client.catalog module
          • CatalogClient
            • CatalogClient.application_details()
            • CatalogClient.list_applications()
            • CatalogClient.list_clusters()
            • CatalogClient.list_desktops()
            • CatalogClient.queue_details()
        • pyepic.client.data module
          • DataClient
            • DataClient.delete()
            • DataClient.download_file()
            • DataClient.get_file_meta_data()
            • DataClient.ls()
            • DataClient.meta_source
            • DataClient.sync()
            • DataClient.upload_file()
          • DataObject
          • DataThread
            • DataThread.download_key()
            • DataThread.run()
            • DataThread.upload_file()
        • pyepic.client.desktop module
          • DesktopClient
            • DesktopClient.get_details()
            • DesktopClient.get_quote()
            • DesktopClient.launch()
            • DesktopClient.list()
            • DesktopClient.terminate()
        • pyepic.client.job module
          • JobClient
            • JobClient.cancel()
            • JobClient.get_details()
            • JobClient.get_job_residual_names()
            • JobClient.get_job_residual_values()
            • JobClient.get_quote()
            • JobClient.get_step_details()
            • JobClient.get_step_logs()
            • JobClient.list()
            • JobClient.list_steps()
            • JobClient.submit()
        • pyepic.client.projects module
          • ProjectClient
            • ProjectClient.get_details()
            • ProjectClient.list()
        • pyepic.client.teams module
          • TeamsClient
            • TeamsClient.get_details()
            • TeamsClient.list()
        • Module contents
      • pyepic.desktops package
        • Submodules
        • pyepic.desktops.desktop module
          • Desktop
            • Desktop.get_launch_spec()
            • Desktop.get_quote_spec()
          • MountType
            • MountType.OFFLINE
            • MountType.ONLINE
        • Module contents
    • Module contents