|
6 | 6 | <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
7 | 7 |
|
8 | 8 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
9 | | - <title>Getting started — diffpy.apps 0.0.1 documentation</title> |
| 9 | + <title>Getting started — diffpy.apps 0.1.1rc0 documentation</title> |
10 | 10 | <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" /> |
12 | 12 | <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> |
13 | 13 |
|
14 | 14 |
|
15 | 15 | <script src="_static/jquery.js?v=5d32c60e"></script> |
16 | 16 | <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
17 | | - <script src="_static/documentation_options.js?v=f539c95a"></script> |
| 17 | + <script src="_static/documentation_options.js?v=e3d08f8f"></script> |
18 | 18 | <script src="_static/doctools.js?v=fd6eb6e6"></script> |
19 | 19 | <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> |
20 | 20 | <script src="_static/clipboard.min.js?v=a7894cd8"></script> |
|
95 | 95 | <span id="runmacro"></span><h2>Use <code class="docutils literal notranslate"><span class="pre">runmacro</span></code> to start refinement with a macro file<a class="headerlink" href="#use-runmacro-to-start-refinement-with-a-macro-file" title="Link to this heading"></a></h2> |
96 | 96 | <p>The <code class="docutils literal notranslate"><span class="pre">runmacro</span></code> application allows users to execute macros written in the |
97 | 97 | diffpy macro language.</p> |
98 | | -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy.app<span class="w"> </span>runmacro<span class="w"> </span><macro_file.dp-in> |
| 98 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy-app<span class="w"> </span>runmacro<span class="w"> </span><macro_file.dp-in> |
99 | 99 | </pre></div> |
100 | 100 | </div> |
101 | 101 | <p>To follow the example,</p> |
|
111 | 111 | <ol class="arabic simple" start="3"> |
112 | 112 | <li><p>run the macro using the <code class="docutils literal notranslate"><span class="pre">runmacro</span></code> application</p></li> |
113 | 113 | </ol> |
114 | | -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy.app<span class="w"> </span>runmacro<span class="w"> </span>example_macro.dp-in |
| 114 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy-app<span class="w"> </span>runmacro<span class="w"> </span>example_macro.dp-in |
115 | 115 | </pre></div> |
116 | 116 | </div> |
117 | 117 | <section id="how-to-write-macro"> |
@@ -215,20 +215,20 @@ <h3>How to write macro<a class="headerlink" href="#how-to-write-macro" title="Li |
215 | 215 | <span id="agentify"></span><h2>Use <code class="docutils literal notranslate"><span class="pre">agentify</span></code> to deploy agent skills <code class="docutils literal notranslate"><span class="pre">diffpy.cmi</span></code><a class="headerlink" href="#use-agentify-to-deploy-agent-skills-diffpy-cmi" title="Link to this heading"></a></h2> |
216 | 216 | <p>The <code class="docutils literal notranslate"><span class="pre">agentify</span></code> application allows users to deploy agentic skills in the |
217 | 217 | local environment. To use this application, run:</p> |
218 | | -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy.app<span class="w"> </span>agentify |
| 218 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy-app<span class="w"> </span>agentify |
219 | 219 | </pre></div> |
220 | 220 | </div> |
221 | 221 | <p><code class="docutils literal notranslate"><span class="pre">claude</span></code> and <code class="docutils literal notranslate"><span class="pre">codex</span></code> agent skills are supported, and <code class="docutils literal notranslate"><span class="pre">claude</span></code> is used |
222 | 222 | by default. To specify the agent skill, use the <code class="docutils literal notranslate"><span class="pre">--agent</span></code> option:</p> |
223 | | -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy.app<span class="w"> </span>agentify<span class="w"> </span>--agent<span class="w"> </span>codex |
| 223 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy-app<span class="w"> </span>agentify<span class="w"> </span>--agent<span class="w"> </span>codex |
224 | 224 | </pre></div> |
225 | 225 | </div> |
226 | 226 | <p>To deploy the agentic skill to the system directory, use the <code class="docutils literal notranslate"><span class="pre">--system</span></code> flag:</p> |
227 | | -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy.app<span class="w"> </span>agentify<span class="w"> </span>--system |
| 227 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy-app<span class="w"> </span>agentify<span class="w"> </span>--system |
228 | 228 | </pre></div> |
229 | 229 | </div> |
230 | 230 | <p>To update the existing <code class="docutils literal notranslate"><span class="pre">diffpy.cmi</span></code> agentic skill, use the <code class="docutils literal notranslate"><span class="pre">--update</span></code> flag:</p> |
231 | | -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy.app<span class="w"> </span>agentify<span class="w"> </span>--update |
| 231 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>diffpy-app<span class="w"> </span>agentify<span class="w"> </span>--update |
232 | 232 | </pre></div> |
233 | 233 | </div> |
234 | 234 | </section> |
|
0 commit comments