You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit ba9bbc6
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -179,7 +179,7 @@ This can be run using the editor tab at https://kigalisim.org/ or locally via `j
179
179
Developers can continue their work by going to the [User Guide](https://kigalisim.org/guide/) which had information on other features. See also the [formal QubecTalk language specification](https://kigalisim.org/guide/qubectalk.pdf).
180
180
181
181
### LLM assistants
182
-
If desired, AI coding assistants or chatbots can help in using Kigali Sim. We implement the [llms.txt specification](https://llmstxt.org), a standard that allows users to bring their own LLM assistants to the tool. Direct your AI to read `https://kigalisim.org/llms-full.txt?v=20260826` and / or `https://kigalisim.org/llms.txt?v=20260826`.
182
+
If desired, AI coding assistants or chatbots can help in using Kigali Sim. We implement the [llms.txt specification](https://llmstxt.org), a standard that allows users to bring their own LLM assistants to the tool. Direct your AI to read `https://kigalisim.org/llms-full.txt?v=20261025` and / or `https://kigalisim.org/llms.txt?v=20261025`.
Copy file name to clipboardExpand all lines: docs/guide/tutorial_03a.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -51,10 +51,10 @@ <h2>Preparing for AI</h2>
51
51
In this tutorial series, we have used <ahref="https://claude.ai/">Claude</a>. However, in practice, most AI assistants can help with Kigali Sim using a standard called <ahref="https://llmstxt.org/">llms.txt</a>. So, to get AI ready to go, please create a new chat session. Then, tell it to look up information about Kigali Sim through a message like this:
52
52
</p>
53
53
54
-
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20260826 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
54
+
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20261025 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
55
55
56
56
<p>
57
-
Need a little cheat? <ahref="tutorial_02.qta" download>Download the Tutorial 2</a> file here. Also, for more capable assistants like Claude, this is enough. However, some assistants cannot access the full internet or won't know how to work with this kind of file out of the box. If your assistant is having issues, instead, attach the <ahref="https://kigalisim.org/llms-full.txt?v=20260826" download>Kigali Sim llms-full.txt</a> file as an attachment!
57
+
Need a little cheat? <ahref="tutorial_02.qta" download>Download the Tutorial 2</a> file here. Also, for more capable assistants like Claude, this is enough. However, some assistants cannot access the full internet or won't know how to work with this kind of file out of the box. If your assistant is having issues, instead, attach the <ahref="https://kigalisim.org/llms-full.txt?v=20261025" download>Kigali Sim llms-full.txt</a> file as an attachment!
Copy file name to clipboardExpand all lines: docs/guide/tutorial_04a.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -61,10 +61,10 @@ <h2>Preparing for AI</h2>
61
61
<strong>If you are new to the AI</strong> or just want to start fresh, create a new chat session. Then, tell it to look up information about Kigali Sim through a message like this:
62
62
</p>
63
63
64
-
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20260826 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
64
+
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20261025 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
65
65
66
66
<p>
67
-
Need a little cheat? <ahref="tutorial_03.qta" download>Download the Tutorial 3</a> file here. Also, for more capable assistants like Claude, this is enough. However, some assistants cannot access the full internet or won't know how to work with this kind of file out of the box. If your assistant is having issues, instead, attach the <ahref="https://kigalisim.org/llms-full.txt?v=20260826" download>Kigali Sim llms-full.txt</a> file as an attachment!
67
+
Need a little cheat? <ahref="tutorial_03.qta" download>Download the Tutorial 3</a> file here. Also, for more capable assistants like Claude, this is enough. However, some assistants cannot access the full internet or won't know how to work with this kind of file out of the box. If your assistant is having issues, instead, attach the <ahref="https://kigalisim.org/llms-full.txt?v=20261025" download>Kigali Sim llms-full.txt</a> file as an attachment!
Copy file name to clipboardExpand all lines: docs/guide/tutorial_06a.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -55,10 +55,10 @@ <h2>Preparing for AI</h2>
55
55
In this case, let's create a new chat session. Then, tell it to look up information about Kigali Sim through a message like this:
56
56
</p>
57
57
58
-
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20260826 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
58
+
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20261025 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
59
59
60
60
<p>
61
-
Need a little cheat? <ahref="tutorial_05.qta" download>Download the Tutorial 5</a> file here. Also, for more capable assistants like Claude, this is enough. However, some assistants cannot access the full internet or won't know how to work with this kind of file out of the box. If your assistant is having issues, instead, attach the <ahref="https://kigalisim.org/llms-full.txt?v=20260826" download>Kigali Sim llms-full.txt</a> file as an attachment!
61
+
Need a little cheat? <ahref="tutorial_05.qta" download>Download the Tutorial 5</a> file here. Also, for more capable assistants like Claude, this is enough. However, some assistants cannot access the full internet or won't know how to work with this kind of file out of the box. If your assistant is having issues, instead, attach the <ahref="https://kigalisim.org/llms-full.txt?v=20261025" download>Kigali Sim llms-full.txt</a> file as an attachment!
Copy file name to clipboardExpand all lines: docs/guide/tutorial_11.html
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ <h2>Assistants</h2>
84
84
<ahref="https://chatgpt.com/">ChatGPT</a> tends to perform well if given an example. Consider providing a tutorial qta file in your initial prompt like so:
85
85
</p>
86
86
87
-
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20260826 and an example simulation at https://kigalisim.org/guide/tutorial_02.qta. Please follow the structure of that Tutorial 2 with similar keywords and layout in order to write correct QubecTalk code though you may use the other keywords and language features mentioned in llms-full.txt. Please review and then we will build a simulation together.</code></pre>
87
+
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20261025 and an example simulation at https://kigalisim.org/guide/tutorial_02.qta. Please follow the structure of that Tutorial 2 with similar keywords and layout in order to write correct QubecTalk code though you may use the other keywords and language features mentioned in llms-full.txt. Please review and then we will build a simulation together.</code></pre>
88
88
89
89
<p>
90
90
Depending on where you use ChatGPT, it may just give you back code instead of a file. This can be copied and pasted into the <strong>Editor</strong> tab. If you instructed ChatGPT to only use UI-editor compatible code, you can update the code and go back to the <strong>Designer</strong> tab to continue with UI-based authoring.
@@ -108,7 +108,7 @@ <h2>Assistants</h2>
108
108
Different versions of copilot might perform differently. See <ahref="https://copilot.microsoft.com/">copilot.microsoft.com</a>. In general, Copilot tends to work best when working from an example so you may want to start with a prompt like this:
109
109
</p>
110
110
111
-
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20260826 and an example simulation at https://kigalisim.org/guide/tutorial_02.qta. Please follow the structure of that Tutorial 2 with similar keywords and layout in order to write correct QubecTalk code though you may use the other keywords and language features mentioned in llms-full.txt. Please review and then we will build a simulation together.</code></pre>
111
+
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20261025 and an example simulation at https://kigalisim.org/guide/tutorial_02.qta. Please follow the structure of that Tutorial 2 with similar keywords and layout in order to write correct QubecTalk code though you may use the other keywords and language features mentioned in llms-full.txt. Please review and then we will build a simulation together.</code></pre>
112
112
113
113
<p>
114
114
Depending on where you use Copilot, it may just give you back code instead of a file. This can be copied and pasted into the <strong>Editor</strong> tab. If you instructed Copilot to only use UI-editor compatible code, you can update the code and go back to the <strong>Designer</strong> tab to continue with UI-based authoring.
@@ -123,7 +123,7 @@ <h2>Assistants</h2>
123
123
Visit <ahref="https://chat.deepseek.com/">chat.deepseek.com</a>. DeepSeek tends to work fairly well but may require a reminder to add the simulations stanza like so:
124
124
</p>
125
125
126
-
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20260826. Then, we will build a simulation together. Please be sure to include the simulation stanza like seen in https://kigalisim.org/guide/tutorial_02.qta.</code></pre>
126
+
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20261025. Then, we will build a simulation together. Please be sure to include the simulation stanza like seen in https://kigalisim.org/guide/tutorial_02.qta.</code></pre>
127
127
</div>
128
128
</details>
129
129
@@ -178,10 +178,10 @@ <h2>Giving the AI information</h2>
178
178
At minimum, you should tell your AI to read <ahref="https://kigalisim.org/llms.txt" target="_blank">kigalisim.org/llms.txt</a> but we find that providing both <code>llms.txt</code> and <code>llms-full.txt</code> is helpful. Here is how you might want to start.
179
179
</p>
180
180
181
-
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20260826. Then, we will build a simulation together.</code></pre>
181
+
<preclass="prompt-code"><code>Hello! Please review https://preview.kigalisim.org/llms-full.txt?v=20261025. Then, we will build a simulation together.</code></pre>
182
182
183
183
<p>
184
-
<strong>Note</strong>: You may want to review the <ahref="#assistants">assistants</a> section for tips on making your specific AI assistant work well. Also, the use of the version (v=20260826) is optional but we recommend it to ensure you have the latest copy.
184
+
<strong>Note</strong>: You may want to review the <ahref="#assistants">assistants</a> section for tips on making your specific AI assistant work well. Also, the use of the version (v=20261025) is optional but we recommend it to ensure you have the latest copy.
Copy file name to clipboardExpand all lines: docs/guide/tutorial_11a.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -100,7 +100,7 @@ <h2>Setting up a project</h2>
100
100
101
101
A few pieces of guidance:
102
102
103
-
- Before starting, please read https://kigalisim.org/llms-full.txt?v=20260826 to learn more about Kigali Sim.
103
+
- Before starting, please read https://kigalisim.org/llms-full.txt?v=20261025 to learn more about Kigali Sim.
104
104
- Please use both census data for equipment population and the imports in tonnes if possible to have both datasets support each other.
105
105
- Please lean on Kigali Sim to do calculations where it can be useful including unit conversions, determining substance allocation across different needs, calculating populations, etc.
106
106
- Please use the `.txt` extension for qubectalk files so they are easier to read in chat.
Copy file name to clipboardExpand all lines: editor/index.html
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -167,12 +167,12 @@ <h2>AI Assistant</h2>
167
167
<p>AI assistants can help you build Kigali Sim simulations by reading and writing QubecTalk code. Direct your assistant to read our documentation and then provide your code for help. For a step-by-step guide, see <ahref="/guide/tutorial_11.html" target="_blank">Tutorial 11: AI Coding Assistants</a>.</p>
<li><ahref="https://kigalisim.org/llms.txt?v=20260826" target="_blank">https://kigalisim.org/llms.txt?v=20260826</a> — index with links to tutorials and references</li>
<li><ahref="https://kigalisim.org/llms.txt?v=20261025" target="_blank">https://kigalisim.org/llms.txt?v=20261025</a> — index with links to tutorials and references</li>
172
172
</ul>
173
173
<details>
174
174
<summary>More details</summary>
175
-
<p><strong>Version Parameters:</strong> The version parameter (e.g., ?v=20260826) is optional but recommended. It helps ensure your AI assistant accesses the latest documentation by avoiding cached versions.</p>
175
+
<p><strong>Version Parameters:</strong> The version parameter (e.g., ?v=20261025) is optional but recommended. It helps ensure your AI assistant accesses the latest documentation by avoiding cached versions.</p>
176
176
<p><strong>Tip:</strong> For LLMs which cannot access the internet, you can <ahref="/llms-full.txt" download>download llms-full.txt</a> and provide it as an attachment to your AI assistant.</p>
177
177
<p><strong>Note:</strong> Using AI assistants is entirely optional. Their use is subject to their respective terms of service and privacy policies.</p>
178
178
<p><strong>Privacy:</strong> Using an AI assistant may involve disclosing information about your simulation to the AI and its cloud provider. Be sure to check their privacy policies and any policies negotiated by your organization.</p>
@@ -185,7 +185,7 @@ <h2>AI Assistant</h2>
185
185
<dialogid="ai-designer-dialog">
186
186
<h2>AI Assistant</h2>
187
187
<p>AI assistants can help you build Kigali Sim simulations. Start a chat with any AI assistant and send a message like this:</p>
188
-
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20260826 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
188
+
<preclass="prompt-code"><code>Hello! I would like help with building a Kigali Sim simulation. Please read https://kigalisim.org/llms-full.txt?v=20261025 to learn more. Please stick to only features compatible with the UI editor.</code></pre>
189
189
<p>For a step-by-step walkthrough, see <ahref="/guide/tutorial_03a.html" target="_blank">Tutorial 3a: Multiple Substances with AI</a>.</p>
Copy file name to clipboardExpand all lines: llms-full.txt
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Kigali Sim - Montreal Protocol Policy Simulation Tool
2
-
v=20260826
2
+
v=20261025
3
3
4
4
Kigali Sim is an open source web-based simulation engine for modeling substances, applications, and policies related to the Montreal Protocol and Kigali Amendment. See [llms.txt](llms.txt) (http://kigalisim.org/llms.txt) for an index of additional documentation and tutorials. It can model high global warming potential greenhouse gases such as HFCs and supports business-as-usual scenarios as well as policy interventions.
Copy file name to clipboardExpand all lines: llms.txt
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Kigali Sim
2
-
v=20260826
2
+
v=20261025
3
3
4
4
Open source web-based simulation engine for Montreal Protocol policy modeling. It is **strongly** recommended to review [llms-full.txt](llms-full.txt) which can be found at http://kigalisim.org/llms-full.txt.
0 commit comments