<!-- Source: https://docs.biosimulant.com/standards/model-compatibility/catalogue -->

# Profile catalogue

A profile is a reusable set of rules for one kind of data, such as gene expression counts or a scalar concentration. Search the catalogue to find a profile for a port, then add its `ref` and `sha256` to your `model.yaml`, as shown in [Adding compatibility to `model.yaml`](/standards/model-compatibility/model-yaml).

Version <code>0.1.0-alpha.5</code> has 650 profiles, built from 266 contract items grouped into 30 packs.

**Warning:**

  No profile has been scientifically reviewed yet. In this release, 591 profiles are `candidate` and 59 are `draft`. The Review column shows each profile's status exactly as the standard records it.

The table doesn't show `sha256` values. To get one, run `biosimulant compatibility profiles list --domain DOMAIN`, or find the profile in [catalogue-index.json](/standards/model-compatibility/v0.1/catalogue-index.json).

## Stage

The Stage column shows where a profile sits in the rollout plan.

| Stage | Meaning | In this release |
|---|---|---|
| `FOUNDATION` | Basic shapes that other profiles build on, such as scalar quantities, matrices and time series | 43 profiles, in the core and simulation domains |
| `V0.1_PILOT` | The first set of profiles chosen for implementation and testing | 16 profiles |
| `WAVE_2` | Planned profiles that follow the pilot set | 541 profiles |
| `CONTROLLED` | Only for use under explicit policy, privacy, licensing or scientific oversight | 25 profiles, all in epidemiology |
| `DEFERRED` | Listed for future work, and not yet supported for use | 25 profiles, all in clinical |
| `CURRENT` | Describes something the runtime or `model.yaml` already supports | None |

## Review

The Review column shows whether a profile has been scientifically reviewed.

| Review | Meaning |
|---|---|
| `candidate` | Proposed. No review yet. |
| `draft` | Under review, not approved yet. |
| `reviewed` | Approved by a named scientific reviewer who didn't write the profile |
| `deprecated` | Still valid in existing lock files, but don't use it for new models |
| `revoked` | Has a serious error. Don't use it in new plans. |

Stage and review status are separate. Passing the [conformance tests](/standards/model-compatibility/conformance) doesn't change a profile's review status. The requirements for `reviewed` are in `PROFILE_REVIEW.md` in the [standard repository](https://github.com/Biosimulant/model-compatibility-standard).

## Download the catalogue

- [Catalogue index](/standards/model-compatibility/v0.1/catalogue-index.json): a summary of every profile, including its `ref` and `sha256`. The search above uses this file.
- [Full catalogue](/standards/model-compatibility/v0.1/catalogue.json): all profiles, contract items and packs in one file
- [Contract items](/standards/model-compatibility/v0.1/items.json): every field a contract can set
- [Item packs](/standards/model-compatibility/v0.1/item-packs.json): groups of fields that profiles share
- [Bundle manifest](/standards/model-compatibility/v0.1/bundle.json): every file in the release, with its sha256

Each profile in the table links to its row on a domain page, and each row links to the profile's JSON definition.
