Skip to content

ziatdinovmax/SciLink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1,250 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

SciLink

AI-Powered Scientific Research Automation Platform

SciLink Logo

SciLink employs a system of intelligent agents to automate experimental design, data analysis, and iterative optimization workflows. Built around large language models with domain-specific tools, these agents act as AI research partners that can plan experiments, analyze results across multiple modalities, and suggest optimal next steps.


Overview

SciLink provides three complementary agent systems that cover the full scientific research cycle:

System Purpose Key Capabilities
Planning Agents Experimental design & optimization Hypothesis generation, Bayesian optimization, literature-aware planning
Analysis Agents Multi-modal data analysis Image analysis, spectroscopy, hyperspectral datacubes, curve fitting
Simulation Agents Computational modeling DFT calculations, classical MD (LAMMPS), structure recommendations

All systems support three autonomy levels:

  • Co-Pilot (default) β€” Human leads, AI assists. Reviews every step.
  • Supervised β€” AI leads, human reviews major decisions.
  • Autonomous β€” Full autonomy, no human review.

Installation

pip install scilink

# With web UI
pip install scilink[ui]

# With simulation dependencies (ASE, atomate2, etc.)
pip install scilink[sim]

The analysis agents work without additional dependencies, but installing Meta's Segment Anything Model (SAM) enables more advanced particle and grain segmentation. SAM is not available on PyPI and must be installed from source:

pip install git+https://github.com/facebookresearch/segment-anything.git

Environment Variables

Set API keys for your preferred LLM provider:

# Google Gemini (default)
export GEMINI_API_KEY="your-key"

# OpenAI
export OPENAI_API_KEY="your-key"

# Anthropic
export ANTHROPIC_API_KEY="your-key"

# OpenAI-compatible proxy (if applicable)
export SCILINK_API_KEY="your-key"

When using SCILINK_API_KEY, also provide a --base-url pointing to your OpenAI-compatible endpoint.


Quick Start

SciLink can be used via the CLI, web UI, MCP server, or Python API.

CLI

# Planning session
scilink plan
scilink plan --autonomy supervised --data-dir ./results --knowledge-dir ./papers

# Analysis session
scilink analyze
scilink analyze --data ./sample.tif --metadata ./metadata.json

Web UI

scilink ui

Requires pip install scilink[ui].

MCP Server

scilink serve --model claude-opus-4-6

See MCP Integration for details.

Python API

from scilink.agents.planning_agents import PlanningAgent
from scilink.agents.exp_agents import AnalysisOrchestratorAgent, AnalysisMode

# Generate an experimental plan
planner = PlanningAgent(model_name="claude-opus-4-6")
plan = planner.propose_experiments(
    objective="Optimize lithium extraction yield",
    knowledge_paths=["./literature/"],
    primary_data_set={"file_path": "./composition_data.xlsx"}
)

# Analyze image data
analyzer = AnalysisOrchestratorAgent(analysis_mode=AnalysisMode.SUPERVISED)
result = analyzer.chat("Analyze ./stem_image.tif and generate scientific claims")

SciLink Reports


MCP Integration

SciLink supports the Model Context Protocol (MCP) as both a server (exposing its tools/agents to external clients like Claude Code) and a client (connecting to external MCP servers for additional capabilities).

As an MCP Server

Expose SciLink's analysis and planning tools to any MCP-compatible client:

# Default (stdio transport, autonomous mode)
scilink serve --model claude-opus-4-6

# Analysis only, with human approval for major actions
scilink serve --mode analyze --autonomy co-pilot

# HTTP transport (SSE)
scilink serve --transport sse --host 127.0.0.1 --port 8000

The server exposes all orchestrator tools (prefixed scilink_ for analysis, scilink_plan_ for planning), plus job management tools for long-running operations. Autonomy modes control which tools require human approval before execution. See docs/claude_code_integration.md for the full MCP server guide.

As an MCP Client

Connect external MCP servers to extend SciLink with additional tools:

# Python MCP server (e.g., arXiv paper search)
scilink analyze --mcp stdio:arxiv:python,-m,arxiv_mcp_server,--storage-path,/tmp/papers

Programmatically:

orchestrator = AnalysisOrchestratorAgent()
tool_count = orchestrator.connect_mcp_server(
    server_name="arxiv",
    command=["python", "-m", "arxiv_mcp_server", "--storage-path", "/tmp/papers"]
)

In the web UI, go to the Tools tab > MCP Servers section, select a transport (stdio/SSE), enter the server name and command, and click Connect.

See docs/mcp_client_integration.md for the full MCP guide.


Extensibility

SciLink supports custom tools, skills, and agents that can be added via CLI flags, the web UI, or programmatically.

Custom Tools

Provide a Python file with tool_schemas (list of OpenAI-format tool dicts) and a create_tool_functions(data) factory:

scilink analyze --tools ./my_image_tools.py

See docs/custom_tools_integration.md for the full guide, including how custom tool outputs flow into built-in agents and how to feed a preprocessed file back into the analysis pipeline.

Custom Skills

Add domain-specific analysis guidance via Markdown skill files:

scilink analyze --skills ./raman_skill.md ./ftir_skill.md

Built-in skills are available for image analysis (atomic-resolution STEM, etc.), curve fitting (XPS, Raman, etc.), and hyperspectral analysis (EELS, etc.).

Custom Agents

Register additional BaseAnalysisAgent subclasses:

scilink analyze --agents ./my_xrd_agent.py

Planning Agents

SciLink Planning Agent

The Planning Agents module automates experimental design, data analysis, and iterative optimization workflows.

Architecture

PlanningOrchestratorAgent (main coordinator)
β”œβ”€β”€ PlanningAgent (scientific strategy)
β”‚   β”œβ”€β”€ Dual KnowledgeBase (Docs KB + Code KB)
β”‚   β”œβ”€β”€ RAG Engine (retrieval-augmented generation)
β”‚   └── Literature Agent (external search)
β”œβ”€β”€ ScalarizerAgent (raw data β†’ scalar metrics)
└── BOAgent (Bayesian optimization)
Agent Purpose
PlanningOrchestratorAgent Coordinates the full experimental workflow via natural language
PlanningAgent Generates experimental strategies using dual knowledge bases
ScalarizerAgent Converts raw data (CSV, Excel) into optimization-ready metrics
BOAgent Suggests optimal parameters via Bayesian Optimization

CLI Usage

scilink plan
scilink plan --autonomy supervised --data-dir ./results --knowledge-dir ./papers
scilink plan --model claude-opus-4-5

Interactive Session Example

$ scilink plan

πŸ“‹ What's your research objective?
Your objective: Optimize lithium extraction from brine

πŸ‘€ You: Generate a plan using papers in ./literature/

πŸ€– Agent: ⚑ Generating Initial Plan...
    πŸ“š Retrieved 8 document chunks.

πŸ”¬ EXPERIMENT 1: pH-Controlled Selective Precipitation
> 🎯 Hypothesis: Adjusting pH to 10-11 will selectively precipitate Mg(OH)β‚‚ while retaining Li⁺

πŸ‘€ You: Analyze ./results/batch_001.csv and run optimization

πŸ€– Agent: [calls analyze_file β†’ {"metrics": {"yield": 78.5}}]
  [calls run_optimization β†’ {"recommended_parameters": {"temp": 85.2, "pH": 6.8}}]

CLI Commands

Command Description
/help Show available commands
/tools List all available agent tools
/files List files in workspace
/state Show current agent state
/autonomy [level] Show or change autonomy level
/checkpoint Save session checkpoint
/quit Exit session

Python API

from scilink.agents.planning_agents.planning_orchestrator import (
    PlanningOrchestratorAgent, AutonomyLevel
)
from scilink.agents.planning_agents import PlanningAgent, ScalarizerAgent, BOAgent

# Using the orchestrator
orchestrator = PlanningOrchestratorAgent(
    objective="Optimize reaction yield",
    autonomy_level=AutonomyLevel.SUPERVISED,
    data_dir="./experimental_results",
    knowledge_dir="./papers"
)
response = orchestrator.chat("Generate initial plan and analyze batch_001.csv")

# Direct agent usage
agent = PlanningAgent(model_name="claude-opus-4-6")
plan = agent.propose_experiments(
    objective="Screen precipitation conditions",
    knowledge_paths=["./literature/"],
    primary_data_set={"file_path": "./composition_data.xlsx"}
)

# Bayesian optimization
bo = BOAgent(model_name="claude-opus-4-6")
result = bo.run_optimization_loop(
    data_path="./optimization_data.csv",
    objective_text="Maximize yield while minimizing cost",
    input_cols=["Temperature", "pH", "Concentration"],
    input_bounds=[[20, 80], [6, 10], [0.1, 2.0]],
    target_cols=["Yield"],
    batch_size=1
)

Experimental Analysis Agents

SciLink Analysis Agent

The Analysis Agents module provides automated scientific data analysis across multiple modalities.

Architecture

AnalysisOrchestratorAgent (main coordinator)
β”œβ”€β”€ CurveFittingAgent (ID: 0)
β”œβ”€β”€ ImageAnalysisAgent (ID: 1)
└── HyperspectralAnalysisAgent (ID: 2)
ID Agent Use Case
0 CurveFittingAgent 1D fitting β€” XRD, UV-Vis, PL, DSC, TGA, kinetics
1 ImageAnalysisAgent All image types β€” microscopy, SEM, TEM, AFM, optical. Handles atomic resolution, grains, particles, textures, defects, morphology
2 HyperspectralAnalysisAgent Spectroscopic datacubes β€” EELS-SI, EDS, Raman imaging

ImageAnalysisAgent uses a two-tier pipeline: Tier 1 performs foundational detection and measurement, while Tier 2 (triggered automatically or on demand) handles deeper analysis such as strain mapping, sublattice separation, or defect classification. The analysis_depth parameter controls this behavior ("auto", "basic", or "deep").

CLI Usage

scilink analyze
scilink analyze --data ./sample.tif --metadata ./metadata.json
scilink analyze --mode autonomous --data ./spectrum.npy

Interactive Session Example

$ scilink analyze --data ./stem_image.tif

πŸ‘€ You: Examine my data and suggest an analysis approach

πŸ€– Agent: ⚑ Examining data at ./stem_image.tif...
  β€’ Type: microscopy, Shape: 2048 x 2048
  β€’ Suggested agent: ImageAnalysisAgent (1)

πŸ‘€ You: Run the analysis

πŸ€– Agent: ⚑ Running analysis...
  Tier 1: Detected atomic columns with two distinct intensity populations.
  Tier 2 recommended β€” sublattice separation and displacement field analysis.
  **Scientific Claims Generated:** 3

CLI Commands

Command Description
/help Show available commands
/tools List orchestrator tools
/agents List analysis agents with descriptions
/status Show session state
/mode [level] Show or change analysis mode
/schema Show metadata JSON schema
/quit Exit session

Python API

from scilink.agents.exp_agents import (
    AnalysisOrchestratorAgent, AnalysisMode,
    ImageAnalysisAgent, HyperspectralAnalysisAgent, CurveFittingAgent
)

# Using the orchestrator
orchestrator = AnalysisOrchestratorAgent(
    base_dir="./my_analysis",
    analysis_mode=AnalysisMode.SUPERVISED
)
response = orchestrator.chat("Examine ./data/sample.tif")

# Direct image analysis with two-tier pipeline
agent = ImageAnalysisAgent(analysis_depth="auto")
result = agent.analyze(
    "stem_image.tif",
    system_info={"experiment": {"technique": "HAADF-STEM"}},
    objective="Identify crystal phases and defects"
)

# Image series with outlier detection
result = agent.analyze(
    ["img_001.tif", "img_002.tif", "img_003.tif"],
    series_metadata={"variable": "dose", "values": [1e14, 1e15, 1e16], "unit": "ions/cmΒ²"}
)

# Curve fitting
agent = CurveFittingAgent(output_dir="./curve_output", use_literature=True)
result = agent.analyze(
    ["pl_300K.csv", "pl_350K.csv", "pl_400K.csv"],
    series_metadata={"variable": "temperature", "values": [300, 350, 400], "unit": "K"}
)

Metadata Conversion

from scilink.agents.exp_agents import generate_metadata_json_from_text

# "HAADF-STEM of MoS2 monolayer, 50nm FOV, 300kV"
# β†’ {"experiment_type": "Microscopy", "experiment": {"technique": "HAADF-STEM"}, ...}
metadata = generate_metadata_json_from_text("./experiment_notes.txt")

Novelty Assessment

SciLink can automatically check experimental findings against the scientific literature to identify what's genuinely new. This is powered by integration with FutureHouse AI agents.

πŸ‘€ You: Assess novelty of these claims

πŸ€– Agent: ⚑ Searching literature via FutureHouse...

  πŸ“š [Score 2/5] Mixed 2H/1T phase coexistence β†’ Well-documented
  πŸ€” [Score 3/5] Sulfur vacancy density of 3.2 Γ— 10ΒΉΒ³ cm⁻² β†’ Similar measurements exist
  🌟 [Score 4/5] 1T phase localized within 5nm of grain boundaries β†’ Limited prior reports

  Summary: 1 HIGH-NOVELTY finding identified

The discovery loop: Analysis generates scientific claims β†’ Novelty Assessment scores each against literature β†’ Recommendations prioritize validation experiments for novel findings.


Output Structure

Planning Session

campaign_session/
β”œβ”€β”€ optimization_data.csv      # Accumulated experimental data
β”œβ”€β”€ plan.json                  # Current experimental plan
β”œβ”€β”€ plan.html                  # Rendered plan visualization
β”œβ”€β”€ checkpoint.json            # Session state for restoration
└── output_scripts/            # Generated automation code

Analysis Session

analysis_session/
β”œβ”€β”€ results/
β”‚   └── analysis_{dataset}_{agent}_{timestamp}/
β”‚       β”œβ”€β”€ metadata_used.json
β”‚       β”œβ”€β”€ analysis_results.json
β”‚       β”œβ”€β”€ visualizations/
β”‚       └── report.html
β”œβ”€β”€ chat_history.json
└── checkpoint.json

Simulation Agents (Coming Soon)

The Simulation Agents module will provide AI-powered computational modeling, bridging experimental observations with atomistic simulations.

Agent Purpose
DFTAgent Density Functional Theory workflow automation
MDAgent Classical molecular dynamics simulations via LAMMPS
SimulationRecommendationAgent Recommends structures and simulation objectives based on experimental analysis

Key planned features include experiment-to-simulation pipelines, defect modeling, and direct integration with the Analysis Agents.

Note: This module is currently being refactored. Check back for updates.