Skip to main content

Collection of tasks for analyzing colony dynamics.

Project description

Build status Lint status Documentation Coverage Code style Version License

Collection of tasks for analyzing colony dynamics. Designed to be used both in Prefect workflows and as modular, useful pieces of code.

Installation

The collection can be installed using:

pip install abm-colony-collection

We recommend using Poetry to manage and install dependencies. To install into your Poetry project, use:

poetry add abm-colony-collection

Usage

Prefect workflows

All tasks in this collection are wrapped in a Prefect @task decorator, and can be used directly in a Prefect @flow. Running tasks within a Prefect flow enables you to take advantage of features such as automatically retrying failed tasks, monitoring workflow states, running tasks concurrently, deploying and scheduling flows, and more.

from prefect import flow
from abm_colony_collection import <task_name>

@flow
def run_flow():
    <task_name>()

if __name__ == "__main__":
    run_flow()

See cell-abm-pipeline for examples of using tasks from different collections to build a pipeline for simulating and analyzing agent-based model data.

Individual tasks

Not all use cases require a full workflow. Tasks in this collection can be used without the Prefect @task decorator by simply importing directly from the module:

from abm_colony_collection.<task_name> import <task_name>

def main():
    <task_name>()

if __name__ == "__main__":
    main()

or using the .fn() method:

from abm_colony_collection import <task_name>

def main():
    <task_name>.fn()

if __name__ == "__main__":
    main()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

abm_colony_collection-0.5.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

abm_colony_collection-0.5.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file abm_colony_collection-0.5.0.tar.gz.

File metadata

  • Download URL: abm_colony_collection-0.5.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for abm_colony_collection-0.5.0.tar.gz
Algorithm Hash digest
SHA256 61aeff53e991dfd933644b805bb6122f5f62a6528a21136aa73843ca98fbf2be
MD5 aff1b62e4dacc1fbe89641a118c087f4
BLAKE2b-256 f08be7b4643ba223a70083eeeb9a538b9dec3b97efb368b4095de3b8f63ea0cb

See more details on using hashes here.

File details

Details for the file abm_colony_collection-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for abm_colony_collection-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d109bfc717ec9cf5e1320bb6e98383bc93db2c5c6dd7ce27d018d98943a57e7
MD5 9d54ae164c3f419a2001c701e3db4a1f
BLAKE2b-256 a396acdb5959c75d9eef6656ac4c30f1a0bd5d8a310c6e0e7bdccff7bcd23bc6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page