# Quickstart

Everything you need to start using PLAID and contributing effectively.

---

- [1 Using the library](#1-using-the-library)
- [2 Core concepts](#2-core-concepts)
- [3 Going further](#3-going-further)

---


## 1 Using the library

To use the library, the simplest way is to install it from the packages available:

- on conda-forge for Windows, macOS and Linux:
  ```bash
  conda install -c conda-forge plaid
  ```

- or on PyPi for Linux:
  ```bash
  pip install pyplaid
  ```

**Note**

- Only the conda-forge packages (all operating systems) and the Linux PyPI package include a bundled pyCGNS dependency. In other situations, which we have not tested, pyCGNS must be installed separately beforehand.
- On Apple Silicon, users can force an osx-64 conda environment using CONDA_SUBDIR=osx-64, allowing installation of the existing macOS-64 builds under Rosetta.


## 2 Core concepts

- {doc}`core_concepts/sample` → API: {py:class}`plaid.containers.sample.Sample`
- {doc}`core_concepts/dataset` → API: {py:class}`plaid.containers.dataset.Dataset`
- {doc}`core_concepts/problem_definition` → API: {py:class}`plaid.problem_definition.ProblemDefinition`
- {doc}`core_concepts/feature_identifiers` → API: {py:class}`plaid.types.feature_types.FeatureIdentifier`
- {doc}`core_concepts/defaults`
- {doc}`core_concepts/disk_format`
- {doc}`core_concepts/interoperability`

## 3 Going further

Explore {doc}`example examples_tutorials <examples_tutorials>` for practical use cases and advanced techniques.

The {doc}`API documentation <../autoapi/plaid/index>` provides detailed information on all available classes and methods.

Two companion libraries extend the `plaid` standard to support machine-learning workflows in physics:

- [plaid-bridges](https://github.com/PLAID-lib/plaid-bridges): integrations with popular ML frameworks such as PyTorch Geometric.
- [plaid-ops](https://github.com/PLAID-lib/plaid-ops): standardized operations on PLAID samples and datasets, including advanced mesh processing (some requiring a finite-element engine) powered by [muscat](https://gitlab.com/drti/muscat).