# teemi

<div class="hero">
  <div class="hero-copy">
    <p class="hero-kicker">Scientific Python toolkit</p>
    <h1>Reproducible design-build-test-learn workflows for microbial strain engineering</h1>
    <p class="hero-lead">
      <code>teemi</code> helps scientists and engineers connect sequence design, cloning workflows,
      laboratory tracking, and downstream analysis in notebook-friendly pipelines.
    </p>
  </div>
</div>

The project is for researchers who want a practical Python toolkit for moving from biological design ideas to
documented build plans, test workflows, and analysis outputs in one place.

<p class="fair-callout">
  The name <code>teemi</code> comes from the Greek goddess of fairness, reflecting the project's goal of making
  bioengineering more FAIR: findable, accessible, interoperable, and reusable.
</p>

## Start here

<div class="link-grid">
  <a class="link-card" href="installation.html">
    <h2>Install</h2>
    <p>Set up teemi from PyPI or from a local checkout.</p>
  </a>
  <a class="link-card" href="quickstart.html">
    <h2>Quickstart</h2>
    <p>Get oriented with the main namespaces and where to begin.</p>
  </a>
  <a class="link-card" href="examples/index.html">
    <h2>Examples</h2>
    <p>Browse notebook-driven workflows and case-study material.</p>
  </a>
  <a class="link-card" href="api/index.html">
    <h2>API reference</h2>
    <p>See package-level documentation generated from Python docstrings.</p>
  </a>
</div>

## What problem teemi solves

`teemi` is most useful when a workflow spans several stages of strain construction and you want the same codebase
to support design decisions, experiment planning, sample tracking, and downstream analysis.

## Citation

If you use teemi in scientific work, cite the project publication:
[teemi in PLOS Computational Biology](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1011929).

```{toctree}
:maxdepth: 2
:caption: Documentation

installation
quickstart
tutorials/index
concepts/index
examples/index
api/index
contributing
authors
history
```