LinkAhead Documentation#

What Is LinkAhead?#

LinkAhead connects scientific data across workflows, tools, and scientists to increase its accessibility and interpretability.

LinkAhead is an open source software system built by researchers for researchers with the practical challenges of scientific work in mind. The goal is simple: helping scientists to focus on their research, instead of wasting time on manual and repetitive data management tasks. The guiding principle is that LinkAhead adapts to scientists’ workflows, rather than the other way around.

_images/what_is_linkahead.png — In the data life cycle, LinkAhead ingests data from various sources – electronic lab notebooks (ELNs), lab devices, data bases – and assists researchers in working with this data and eventually publishing it.#

Start now#

Getting Started

First steps with LinkAhead.

tutorial/introduction/index.html

Web Interface

Introduction to the web interface

tutorial/webinterface/index.html

Install LinkAhead

Step-by-step installation.

how_to/admin_guides/installation.html

LinkAhead Python Library

Accessing LinkAhead using the Python client library.

tutorial/scripting/pylib/index.html

LinkAhead Crawler

Crawling data into LinkAhead.

tutorial/crawler/index.html

Concepts

Understand how LinkAhead works.

explanation/general/index.html

How to Read the Documentation#

The documentation contains all the information you need to use LinkAhead and is divided into four chapters which you can access via the top menu bar. These divide the documentation by the goal of each page, as seen below. For further information on the different document types, refer to the diátaxis documentation.

Tutorials	How-To-Guides	Explanation	Reference
Learning new skills	Achieving concrete goals	Understanding LinkAhead	Looking up information

Once you’ve selected one of the menu items, an overview of all the individual topic sections appears on the left-hand side. After selecting a topic, you can see on the right-hand side which subtopics are included within that section.

Additionally, you can find further information in the drop down menu under “More”. Return to this page by clicking on the logo on the left side of the menu.

Report an issue#

Please report all bugs, feature request, or other issues with LinkAhead itself or this documentation by opening an issue in the official LinkAhead repository.