Skip to main content
Ctrl+K
hpcflow 0.2.0a236 documentation - Home hpcflow 0.2.0a236 documentation - Home
  • Install
  • User Guide
  • Reference
  • Development
  • GitHub
  • PyPI
  • Install
  • User Guide
  • Reference
  • Development
  • GitHub
  • PyPI

Section Navigation

  • Getting started
    • Run a demo workflow
    • Write your own task schema and workflow
    • Advanced workflow concepts
    • Common errors
  • How-to guides
    • Configuration
    • Task Schemas
    • Template Components
    • Workflow Templates
    • Workflows
    • Environments
    • Meta-tasks
    • Loops
    • Resources
  • Tutorials
    • Beginner: Install MatFlow on your local machine
  • User Guide

User Guide#

Computational workflow management

  • Getting started
    • Run a demo workflow
      • Submit a workflow
      • Check the status of a workflow
      • Cancel a workflow
      • Workflow output
    • Write your own task schema and workflow
      • Workflow files
      • Components of a task schema
      • hpcFlow syntax
      • Passing variables around a workflow
      • Writing a workflow
      • Example workflow
    • Advanced workflow concepts
      • Resources
      • Task sequences
      • Groups
      • Task schema shortcuts
    • Common errors
      • Submitting a workflow
  • How-to guides
    • Configuration
      • Get and set config items
      • Reset the config to default values
      • Clear the known-submissions file
    • Task Schemas
      • Action command strings
      • Parameter flow within task schemas
    • Template Components
      • How to name parameters and task schemas
    • Workflow Templates
      • Loading workflow templates
    • Workflows
      • Generating a persistent workflow from a workflow template
      • Loading workflows
    • Environments
      • Use multiple versions of the same software
    • Meta-tasks
      • Simple example
      • Customising task parametrisation
    • Loops
      • A basic loop workflow
    • Resources
      • Shell and scheduler arguments
  • Tutorials
    • Beginner: Install MatFlow on your local machine
      • Step 1: Set up a Python environment
      • Step 2: Install hpcFlow
      • Step 3: Configure hpcFlow for your machine
      • Step 4: Define workflow
      • Step 5: Run the workflow
      • Step 6: Monitor the workflow
      • Step 6: View the results

previous

Installation

next

Getting started

Edit on GitHub

This Page

  • Show Source

© Copyright 2023, hpcflow developers.

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.16.1.