1.1. Overview

The Citrine Python client serves as the entry point for creating and interacting with resources on the Citrine Platform. There are a few basic types of resources to become acquainted with: teams, projects, datasets, data objects, and AI modules. A team is a container for datasets and projects that a specific group of people have different access rights to. A project is a container for a thematically related group of AI modules. A dataset is an access control unit for data objects and files: information about materials samples, the way they were processed, and the measurements performed on them. AI modules are used to construct workflows that analyze materials data and make predictions to help inform data-driven materials development.

In this first section, we will cover teams, projects, datasets, and the basic mechanics of creating, reading, updating, and deleting resources. We will also briefly describe data objects and AI modules. For more information on uploading and working with data objects, see this section. A thorough explanation of the various AI modules and how to use them can be found here. Finally, documentation on how to extract information about data objects and express it in a tabular format so it can be consumed by AI modules is found here.