Skip to content

An atomic structure editing agent that translates intuitive natural language prompts into crystal structure modifications.

License

Notifications You must be signed in to change notification settings

MatAgentHub/crystalk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

65 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Crystalk: Atomic Structure Editing Agent

Crystalk is an intelligent atomic structure editing agent that can translate intuitive natural language prompts into crystal structure modifications. By lowering the barrier for researchers and enabling samless communication with other AI agents, it aims to democrtize intuitive atomic manipulation and accelerate materials discovery.

📦 Installation

Clone the repository

git clone https://github.com/MatAgentHub/crystalk.git
cd crystalk

Prepare environment

pip install uv
uv venv .venv
source .venv/bin/activate

Install Crystalk

uv pip install -e .

🚀 Quick Start

Set OpenAI api key:

export OPENAI_API_KEY="YOUR_API_KEY"

Set tavily search api key:

export TAVILY_API_KEY="YOUR_API_KEY"

Launch Crystalk app with a simple command:

crystalk-gui

If you prefer command-line mode:

crystalk in.cif "Make a 3x3x1 supercell." -o ./cif/edited_structure.poscar

🤝 Acknowledgement

This project was developed as part of the 2025 LLM Hackathon for Applications in Materials Science & Chemistry. We would like to thank the organizing team.

As this project is still in its early stages of development and many parts are incomplete, any contributions are highly welcome!

About

An atomic structure editing agent that translates intuitive natural language prompts into crystal structure modifications.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •