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.3.tar.gz (151.0 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.3-py3-none-any.whl (176.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: faradayai-0.1.3.tar.gz
  • Upload date:
  • Size: 151.0 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.3.tar.gz
Algorithm Hash digest
SHA256 33edcf6132c89203fe2b509e6a357dff432dd6ed60fe83dfc8c0db96dcf980de
MD5 76aa38bdf8fa095da9b85b8c3c9ce1bd
BLAKE2b-256 5f81b91c1b45879dd8bb95af4180e37f8a046f2130514952c772e5e9ff396fc1

See more details on using hashes here.

Provenance

The following attestation bundles were made for faradayai-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: faradayai-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 176.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bd30bbbc6a05196fafff38e09ad953edb228064087094012d8668a3c5827998c
MD5 2141e0c58bc68ee4badd83550edfdc2a
BLAKE2b-256 2b9d4988dd095fe0c1f6b57592b804c7413227bc47cb8a87676e88d3ec8eb268

See more details on using hashes here.

Provenance

The following attestation bundles were made for faradayai-0.1.3-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