Quickstart

Everything you need to start using PLAID and contributing effectively.

---

• 1 Using the library

• 2 Core concepts

• 3 Going further

---

1 Using the library

To use the library, the simplest way is to install it as follows:

conda install -c conda-forge plaid

or

sudo apt-get install -y libhdf5-dev
pip install pyplaid

Note

Only the conda-forge package comes with a bundled HDF5 dependency.

2 Core concepts

• Sample → API: plaid.containers.sample.Sample

• Dataset → API: plaid.containers.dataset.Dataset

• Problem definition → API: plaid.problem_definition.ProblemDefinition

• Feature identifiers → API: plaid.types.feature_types.FeatureIdentifier

• Default values mechanics

• On-disk format

• Interoperability

3 Going further

Explore example notebooks for practical use cases and advanced techniques.

The API documentation provides detailed information on all available classes and methods.