Installation

Quilt has two user-facing components:

• A Python client
• A web catalog

Python client

Python 3.9 or higher is required.

$ pip install 'quilt3[pyarrow]'

If you do not need to serialize and deserialize dataframes with Quilt, you can obtain a smaller install, useful in disk-constrained environments like AWS Lambda, with pip install quilt3.

If you plan to use Quilt Catalog Local Development Mode, add catalog extra while installing quilt3, e.g.:

$ pip install 'quilt3[catalog,pyarrow]'

If you wish to use AWS resources, such as S3 buckets, you will need valid AWS credentials. If this is your first time using the AWS CLI, run the following:

$ aws configure

For AWS CLI v2 installation, use the official AWS CLI install guide.

If you are already using the AWS CLI, you may use your existing profile, or create a new profile.

Developer

Install the current Quilt client from master:

$ pip install git+https://github.com/quiltdata/quilt.git#subdirectory=api/python

Enterprise Installation

For installing the Quilt catalog and stack (enterprise deployment on AWS), see the Catalog Installation Guide.