User

User pydantic-model

Bases: BaseModel

A Rowan user.

Attributes:

Name	Type	Description
uuid	str	UUID of the user
username	str	username of the user
email	str	email of the user
firstname	str | None	first name of the user
lastname	str | None	last name of the user
weekly_credits	float | None	weekly credits of the user
credits	float | None	credits of the user
billing_name	str | None	billing name of the user
billing_address	str | dict | None	billing address of the user
credit_balance_warning	float | None	credit balance warning of the user
organization	Organization | None	organization of the user
organization_role	OrganizationRole | None	organization role of the user
individual_subscription	IndividualSubscription | None	individual subscription of the user
enabled_workflows	list[str]	workflow types this account may submit, as backend slugs that mostly match the submit_<slug>_workflow names (note molecular_dynamics is protein MD)
feature_list	list[str]	feature flags enabled for this account

Show JSON schema:

{
  "$defs": {
    "IndividualSubscription": {
      "description": "A Rowan individual subscription.\n\nAttributes:\n    subscription_plan: subscription plan of the individual subscription",
      "properties": {
        "subscription_plan": {
          "$ref": "#/$defs/SubscriptionPlan"
        }
      },
      "required": [
        "subscription_plan"
      ],
      "title": "IndividualSubscription",
      "type": "object"
    },
    "Organization": {
      "description": "A Rowan organization.\n\nAttributes:\n    name: name of the organization\n    weekly_credits: weekly credits of the organization\n    credits: credits of the organization",
      "properties": {
        "name": {
          "title": "Name",
          "type": "string"
        },
        "weekly_credits": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Weekly Credits"
        },
        "credits": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Credits"
        }
      },
      "required": [
        "name"
      ],
      "title": "Organization",
      "type": "object"
    },
    "OrganizationRole": {
      "description": "A Rowan organization role.\n\nAttributes:\n    name: name of the organization role",
      "properties": {
        "name": {
          "title": "Name",
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "title": "OrganizationRole",
      "type": "object"
    },
    "SubscriptionPlan": {
      "description": "A Rowan subscription plan.\n\nAttributes:\n    name: name of the subscription plan",
      "properties": {
        "name": {
          "title": "Name",
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "title": "SubscriptionPlan",
      "type": "object"
    }
  },
  "description": "A Rowan user.\n\nAttributes:\n    uuid: UUID of the user\n    username: username of the user\n    email: email of the user\n    firstname: first name of the user\n    lastname: last name of the user\n    weekly_credits: weekly credits of the user\n    credits: credits of the user\n    billing_name: billing name of the user\n    billing_address: billing address of the user\n    credit_balance_warning: credit balance warning of the user\n    organization: organization of the user\n    organization_role: organization role of the user\n    individual_subscription: individual subscription of the user\n    enabled_workflows: workflow types this account may submit, as backend slugs that\n        mostly match the `submit_<slug>_workflow` names (note `molecular_dynamics` is\n        protein MD)\n    feature_list: feature flags enabled for this account",
  "properties": {
    "uuid": {
      "title": "Uuid",
      "type": "string"
    },
    "username": {
      "title": "Username",
      "type": "string"
    },
    "email": {
      "title": "Email",
      "type": "string"
    },
    "firstname": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Firstname"
    },
    "lastname": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Lastname"
    },
    "weekly_credits": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Weekly Credits"
    },
    "credits": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credits"
    },
    "billing_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Billing Name"
    },
    "billing_address": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Billing Address"
    },
    "credit_balance_warning": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credit Balance Warning"
    },
    "organization": {
      "anyOf": [
        {
          "$ref": "#/$defs/Organization"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "organization_role": {
      "anyOf": [
        {
          "$ref": "#/$defs/OrganizationRole"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "individual_subscription": {
      "anyOf": [
        {
          "$ref": "#/$defs/IndividualSubscription"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "enabled_workflows": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Enabled Workflows",
      "type": "array"
    },
    "feature_list": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Feature List",
      "type": "array"
    }
  },
  "required": [
    "uuid",
    "username",
    "email"
  ],
  "title": "User",
  "type": "object"
}

Fields:

• uuid (str)
• username (str)
• email (str)
• firstname (str | None)
• lastname (str | None)
• weekly_credits (float | None)
• credits (float | None)
• billing_name (str | None)
• billing_address (str | dict | None)
• credit_balance_warning (float | None)
• organization (Organization | None)
• organization_role (OrganizationRole | None)
• individual_subscription (IndividualSubscription | None)
• enabled_workflows (list[str])
• feature_list (list[str])

credits_available_string

credits_available_string() -> str

Returns a string showing available credits, including organization credits if applicable.

Returns:

Type	Description
str	string showing available credits

Organization pydantic-model

Bases: BaseModel

A Rowan organization.

Attributes:

Name	Type	Description
name	str	name of the organization
weekly_credits	float | None	weekly credits of the organization
credits	float | None	credits of the organization

Show JSON schema:

{
  "description": "A Rowan organization.\n\nAttributes:\n    name: name of the organization\n    weekly_credits: weekly credits of the organization\n    credits: credits of the organization",
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    },
    "weekly_credits": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Weekly Credits"
    },
    "credits": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credits"
    }
  },
  "required": [
    "name"
  ],
  "title": "Organization",
  "type": "object"
}

Fields:

• name (str)
• weekly_credits (float | None)
• credits (float | None)

OrganizationRole pydantic-model

Bases: BaseModel

A Rowan organization role.

Attributes:

Name	Type	Description
name	str	name of the organization role

Show JSON schema:

{
  "description": "A Rowan organization role.\n\nAttributes:\n    name: name of the organization role",
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "OrganizationRole",
  "type": "object"
}

Fields:

• name (str)

SubscriptionPlan pydantic-model

Bases: BaseModel

A Rowan subscription plan.

Attributes:

Name	Type	Description
name	str	name of the subscription plan

Show JSON schema:

{
  "description": "A Rowan subscription plan.\n\nAttributes:\n    name: name of the subscription plan",
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "SubscriptionPlan",
  "type": "object"
}

Fields:

• name (str)

IndividualSubscription pydantic-model

Bases: BaseModel

A Rowan individual subscription.

Attributes:

Name	Type	Description
subscription_plan	SubscriptionPlan	subscription plan of the individual subscription

Show JSON schema:

{
  "$defs": {
    "SubscriptionPlan": {
      "description": "A Rowan subscription plan.\n\nAttributes:\n    name: name of the subscription plan",
      "properties": {
        "name": {
          "title": "Name",
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "title": "SubscriptionPlan",
      "type": "object"
    }
  },
  "description": "A Rowan individual subscription.\n\nAttributes:\n    subscription_plan: subscription plan of the individual subscription",
  "properties": {
    "subscription_plan": {
      "$ref": "#/$defs/SubscriptionPlan"
    }
  },
  "required": [
    "subscription_plan"
  ],
  "title": "IndividualSubscription",
  "type": "object"
}

Fields:

• subscription_plan (SubscriptionPlan)

whoami

whoami() -> User

Returns the current user.