Skip to main content

Faraday research agent

Project description

Faraday Agent

PyPI version License: Apache 2.0

Accelerating science with agentic AI for research and drug design

Faraday is an AI scientist that carries out research workflows end to end:

Install

pip install faradayai

Requires Python 3.10+. For a development install from the repo root:

pip install -e .

Credentials

Set a model API key before running. Faraday supports OpenAI, OpenRouter, and Azure OpenAI.

OpenAI (default)

export OPENAI_API_KEY=...

OpenRouter

export OPENROUTER_API_KEY=...
# faraday.yaml
llm:
  provider: openrouter
  model: openai/gpt-5
  api_key_env: OPENROUTER_API_KEY

Azure OpenAI

# faraday.yaml
llm:
  provider: azure
  model: gpt-5
  api_key: OPENAI_API_KEY
  base_url: AZURE_OPENAI_BASE_URL
  api_version: preview

Run faraday --check-tools to verify keys and tool availability after setup.


Quickstart

Run a one-shot task:

faraday "Summarize structure–activity relationships across KRAS inhibitors, focusing on motifs that improve binding affinity and selectivity"

Interactive mode:

faraday

With a config file:

faraday --config faraday.example.yaml "Your task here"

Results are written to ./run_outputs/ by default:

run_outputs/
  run_{timestamp}_{chat_id}_{query_id}/
    agent_outputs/       # files, plots, and generated artifacts
    run_artifacts/
      events.jsonl       # timestamped stream of every agent event
      metadata.json      # run parameters (model, steps, config)
      result.json        # final answer and run summary
      trajectory.json    # full trajectory for replay

Useful flags: --model, --max-steps, --debug, --check-tools, --app-mode, --sandbox-backend, --batch-file, --use-docker. See faraday --help for the full list.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

faradayai-0.1.0.tar.gz (150.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

faradayai-0.1.0-py3-none-any.whl (175.3 kB view details)

Uploaded Python 3

File details

Details for the file faradayai-0.1.0.tar.gz.

File metadata

  • Download URL: faradayai-0.1.0.tar.gz
  • Upload date:
  • Size: 150.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for faradayai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ea91bab59c00546880622e96b3cb7d87e56fa050cf640f0515e51b63ef058331
MD5 edc01936a15f271640e4426a87aafde9
BLAKE2b-256 9d9d26c95a00d7997ba95a8e14bf3bb7cd5a0b66cf9f8b80515979068aeb9db6

See more details on using hashes here.

Provenance

The following attestation bundles were made for faradayai-0.1.0.tar.gz:

Publisher: publish.yml on AscentBio/faraday

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file faradayai-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: faradayai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 175.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for faradayai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5250ad1129a1f771c5e73233c1033e6ff13ac0fb1c2ba849fe9b5874cbbf0ada
MD5 9e447b4e517b1f5a1642c74159c873b5
BLAKE2b-256 9f028e4d44d022368bd4ee1c96b41913989cac466a6c8ebb4805b95eb9199703

See more details on using hashes here.

Provenance

The following attestation bundles were made for faradayai-0.1.0-py3-none-any.whl:

Publisher: publish.yml on AscentBio/faraday

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page