Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

AIDA — AI Data Assistant

Status: beta (0.1.0b6). Everything described below works today and is in daily use. Config formats and CLI commands are stable enough to build on; breaking changes before 1.0 will be called out in CHANGELOG.md. Bug reports and rough edges are exactly what this beta is for — open an issue.

AIDA is a local scientific agent workbench: a simple, reliable desktop GUI (and CLI) for using AI agents in scientific work — conversation with local or cloud LLMs, correct use of domain MCP servers (pyIrena, bait_mcp, ...), correct display of rich tool results (especially PNG plots), reading and producing documents, and controlled access to your own data folders.

It is built for pyIrena and USAXS-instrument users and is deliberately not a general-purpose AI platform — see PLAN.md §1 for the rationale.

What it does

  • Chat with any model you can reach — Ollama / LM Studio / any OpenAI-compatible endpoint, OpenAI itself, Claude direct, or Claude through the ANL Argo proxy. Named profiles, switchable mid-conversation.
  • Use MCP servers properly — a PNG a tool returns is decoded and shown as an image, not flattened to text. Servers are grouped so a small local model isn't drowned in 100+ tool schemas.
  • Work in your folders — named workspaces bundle source folders, a target folder, a provider profile, an MCP group, and skills. The agent reads, writes, searches, and (optionally) runs scripts there under a safety model you configure.
  • Produce documents — Markdown in Obsidian layout (images in a sidecar folder, linked relatively) or DOCX, written into your target folder.
  • Search your own documentation — optional local RAG over folders you choose, with local or cloud embeddings.
  • Keep the documents you attach — an attached paper is copied into the conversation's own folder with the text that was extracted from it, and deleted again with the conversation. Ask about a figure and the agent fetches that one by label rather than being handed every image in the file. Optional Mistral OCR makes those labels reliable on multi-column journal PDFs — off by default, per workspace, and it asks before a document leaves your machine.
  • Keep conversations sorted — label them by person on a shared beamline machine, or by project on a laptop, and filter the list by it. Labels are organization, not security.
  • Stay out of black boxes — token counts and cost estimates per session, a tool-call log, a raw MCP result inspector, and aida doctor.

Install

From PyPI (recommended):

pip install --pre "aida-workbench[gui,docs]"
aida doctor
aida-gui

The PyPI distribution name is aida-workbench; the import package and the console scripts are aida / aida-gui. Extras: gui (PySide6 desktop app), docs (PDF/DOCX/XLSX/PPTX reading, image handling), ocr (the optional Mistral OCR backend for figure extraction).

--pre matters: every release so far is a 0.1.0bN pre-release, and pip never installs a pre-release over a stable one unless asked — omit it and you silently get the long-abandoned 0.0.1 snapshot instead of current beta, with no error to say so.

Already using pyIrena? Install both — in either order, in one environment or two — and wire up its MCP tools with a single command:

pip install --pre "aida-workbench[gui,docs]" "pyirena[all]"
aida mcp add-pyirena

See docs/pyirena.md for the compatibility details and the GUI equivalent.

From a git checkout, for development:

git clone https://github.com/jilavsky/aida.git
cd aida
conda env create -f environment.yml   # or: pip install -e ".[dev,gui,docs]"
conda activate aida
aida doctor

First run

  1. aida doctor — confirms Python, config files, keychain, and folders.
  2. Launch aida-gui. On a fresh install it offers to set up a provider profile and a first workspace; you can also do both from the toolbar (Providers…, Workspaces…) or from the CLI (aida workspace new).
  3. Pick a workspace and profile in the toolbar and start typing.

docs/installation.md → docs/providers-and-secrets.md → docs/workspaces.md is the full path from nothing to a working session.

Documentation

Task-oriented setup and configuration guides — providers, workspaces, the safety model, MCP servers, scripting, RAG, a GUI tour — live in docs/. Fully-commented example config files are in examples/config/.

Status and roadmap

Phases 1–10 of PLAN.md are implemented: config and diagnostics, the provider layer and agent loop, MCP with typed artifacts, persistence and workspaces, the PySide6 GUI, documents and the safety model, MCP management UI, RAG, coding/scripting, and headless automation — aida run, stored workflows, and the in-app scheduler (see docs/workflows.md). Distribution (real PyPI/conda release automation) is what remains open. Completed per-phase checklists live in planning/; what is still open is at the top of PLAN.md.

Released and unreleased changes, version by version, are in CHANGELOG.md.

Requirements

Python >= 3.11. Tested on macOS, Windows, and Linux.

License

MIT — see LICENSE.

Metadata

Release files for aida-workbench 0.1.0b6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aida-workbench 0.1.0b6
File Size Uploaded Provenance
aida_workbench-0.1.0b6.tar.gz 3.2 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for aida-workbench 0.1.0b6
File Interpreter ABI Platform
aida_workbench-0.1.0b6-py3-none-any.whl Python 3 none any Details

Total release size: 3.7 MB

Release files / aida_workbench-0.1.0b6.tar.gz

Download URL aida_workbench-0.1.0b6.tar.gz
Size 3.2 MB
Tags Source
SHA-256 checksum
How to use checksums
229e2fd8907a82b932e46062647f7dd64095cd25fc824e608dc634f4cc62d317
BLAKE2b-256 checksum
How to use checksums
cec8880bd5bc69e7f1369002d3961d307a542343805ce2bfead3e4b12b351104
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.

Transparency log

Release files / aida_workbench-0.1.0b6-py3-none-any.whl

Download URL aida_workbench-0.1.0b6-py3-none-any.whl
Size 486.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
645efda53989c2d426306204b4282b822ee61ac0effc221f6ce61aeb9c81d7f2
BLAKE2b-256 checksum
How to use checksums
81bb8c48a77a164a73a46d394106c07c1d587644f66e8af54961cce5dbccde70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.

Transparency log

Security for aida-workbench 0.1.0b6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for aida_workbench-0.1.0b6.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page