Skip to content

Commit 8b393d2

Browse files
committed
chore: add usecase
1 parent 5fa46b3 commit 8b393d2

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

‎docs/source/diffpy-agent.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,39 @@ which mainly utilizes the "tool" concept applied in most agent frameworks.
77
After connecting these tools to an agent, users can invoke DiffPy
88
functionalities and automate PDF refinements through conversation.
99

10+
To better understand the convenience Diffpy Agent Interface brought,
11+
let's consider the following scenario:
12+
13+
Without Diffpy Agent:
14+
15+
1. Mr Neutron copies the structure and data file inside working directory.
16+
17+
2. Mr Neutron writes ``diffpy.cmi`` script to set the refinement configuration.
18+
19+
3. According to the results, Mr Neutron adjusts the script accordingly.
20+
21+
4. Repeat steps 2 and 3 until the refinement results are satisfactory.
22+
23+
During the process, Mr Neutron has to keep track of multiple versions of
24+
the script and their results to navigate the best refinement strategy.
25+
26+
27+
With Diffpy Agent:
28+
29+
1. Mr Neutron connects the Diffpy tools to the agent.
30+
31+
2. Mr Neutron copies the structure and data file inside the working directory.
32+
33+
3. Mr Neutron asks the agent to perform the refinement
34+
35+
4. According the results, Mr Neutron tells agent to adjust the refinement settings *in few words*.
36+
37+
5. Repeat steps 3 and 4 until the refinement results are satisfactory.
38+
39+
During the process, all inputs and outputs are saved in the conversation. All
40+
information are in their most readable manner, and well-organized for easy reference.
41+
42+
1043
.. _mcp_setup:
1144

1245
Installation and Setup

0 commit comments

Comments
 (0)