Quick Install Guide

There are multiple ways to installing LinkML.

Local installation: Use the Python package

If you are developing locally you can install LinkML as a python package in your local environment.

Install Python

Get the latest version of Python at https://www.python.org/downloads/ or with your operating system’s package manager.

You can verify that Python is installed by typing python from your shell; you should see something like:

Python 3.9.5 (v3.9.5:0a7dcbdb13, May  3 2021, 13:17:02) 
[Clang 6.0 (clang-600.0.57)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>

Install LinkML

The latest version can always be installed with:

pip install linkml

Alternative: Use the official Docker/OCI image

You can also use the official Docker/OCI image for LinkML:

To start a shell from the image:

docker run -v ./:/work -w /work/ --rm -ti docker.io/linkml/linkml

Then try some commands:

$ gen-project --help
/home/runner/.cache/pypoetry/virtualenvs/linkml-OnSywQti-py3.9/lib/python3.9/site-packages/pydantic/_internal/_fields.py:201: UserWarning: Field name "schema" in "Import" shadows an attribute in parent "TemplateModel"
  warnings.warn(
Usage: gen-project [OPTIONS] YAMLFILE

  Generate an entire project LinkML schema
...

See the generators section for more cli entrypoints, or continue to the tutorial

Installation for contributors

note for core developers and contributors: consult the developers guide for using this codebase from GitHub