Skip to content

Commit e843d44

Browse files
committed
updating install instructions
1 parent a99f5bb commit e843d44

File tree

4 files changed

+54
-18
lines changed

4 files changed

+54
-18
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,24 @@ Our project is funded by the [Cambridge Centre for Data-Driven Discovery Acceler
3232

3333
If you plan to modify the code, follow these steps:
3434

35-
Clone and install our package from `PyPi`:
35+
An old version of `cmbagent` is available on `PyPi`, however we are not maintaining it at this time due to intensive development on the new version.
36+
37+
Thus, we recommend cloning the repository and installing it from source. You need `cmbagent` and our fork of `ag2` to get things working.
3638

3739
```bash
38-
pip install cmbagent
39-
```
40+
git clone https://github.com/CMBAgents/cmbagent.git
41+
git clone https://github.com/CMBAgents/ag2.git
42+
cd cmbagent
43+
pip install -e .
44+
cd ..
45+
cd ag2
46+
pip install -e .
47+
```
48+
49+
We apologize for some bugs that you may encounter we hope to release a stable version before the end of 2025.
50+
51+
52+
4053

4154
Before pip installing cmbagent, creating a virual environment is encouraged:
4255
```bash

docs/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
## Installation
22

3-
To install cmbagent, follow these steps:
43

5-
Clone and install our package PyPi:
4+
An old version of `cmbagent` is available on `PyPi`, however we are not maintaining it at this time due to intensive development on the new version.
65

7-
```bash
8-
pip install cmbagent
9-
```
10-
11-
Or clone the repository and install it locally (advised if you want to develop the package, or if you have issues with the installation):
6+
Thus, we recommend cloning the repository and installing it from source. You need `cmbagent` and our fork of `ag2` to get things working.
127

138
```bash
149
git clone https://github.com/CMBAgents/cmbagent.git
10+
git clone https://github.com/CMBAgents/ag2.git
1511
cd cmbagent
1612
pip install -e .
17-
```
13+
cd ..
14+
cd ag2
15+
pip install -e .
16+
```
17+
18+
We apologize for some bugs that you may encounter we hope to release a stable version before the end of 2025.
19+
20+
1821

1922
Creating a virual environment is envouraged:
2023
```bash

docs/notebooks/1_getting_started.ipynb

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
{
3434
"cell_type": "code",
3535
"execution_count": null,
36-
"id": "582f8e04-11ff-43f5-ae7c-681233f7fe8c",
36+
"id": "a1a9f668",
3737
"metadata": {},
3838
"outputs": [],
3939
"source": [
@@ -42,6 +42,26 @@
4242
"!pip install -e ."
4343
]
4444
},
45+
{
46+
"cell_type": "markdown",
47+
"id": "65c3e1cd",
48+
"metadata": {},
49+
"source": [
50+
"## Clone and install our fork of ag2"
51+
]
52+
},
53+
{
54+
"cell_type": "code",
55+
"execution_count": null,
56+
"id": "582f8e04-11ff-43f5-ae7c-681233f7fe8c",
57+
"metadata": {},
58+
"outputs": [],
59+
"source": [
60+
"!git clone https://github.com/CMBAgents/ag2.git\n",
61+
"%cd ag2\n",
62+
"!pip install -e ."
63+
]
64+
},
4565
{
4666
"cell_type": "markdown",
4767
"id": "01402b0f-8098-4416-b83c-300a694d9691",

docs/notebooks/4_your_rag.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -885,7 +885,7 @@
885885
]
886886
},
887887
{
888-
"name": "stdin",
888+
"name": "stdout",
889889
"output_type": "stream",
890890
"text": [
891891
"Provide feedback to cmbagent. Type 'proceed' to continue as suggested or type your suggestion, or type 'exit' to end the conversation: proceed\n"
@@ -999,7 +999,7 @@
999999
]
10001000
},
10011001
{
1002-
"name": "stdin",
1002+
"name": "stdout",
10031003
"output_type": "stream",
10041004
"text": [
10051005
"Provide feedback to cmbagent. Type 'proceed' to continue as suggested or type your suggestion, or type 'exit' to end the conversation: Provide more detailed statistical information from the documents\n"
@@ -1113,7 +1113,7 @@
11131113
]
11141114
},
11151115
{
1116-
"name": "stdin",
1116+
"name": "stdout",
11171117
"output_type": "stream",
11181118
"text": [
11191119
"Provide feedback to cmbagent. Type 'proceed' to continue as suggested or type your suggestion, or type 'exit' to end the conversation: Collect extensive information, which we can summarize into a plot. Your answer should be several paragraphs long\n"
@@ -1237,7 +1237,7 @@
12371237
]
12381238
},
12391239
{
1240-
"name": "stdin",
1240+
"name": "stdout",
12411241
"output_type": "stream",
12421242
"text": [
12431243
"Provide feedback to cmbagent. Type 'proceed' to continue as suggested or type your suggestion, or type 'exit' to end the conversation: now ask engineer to provide a plot that summarizes this\n"
@@ -1385,7 +1385,7 @@
13851385
]
13861386
},
13871387
{
1388-
"name": "stdin",
1388+
"name": "stdout",
13891389
"output_type": "stream",
13901390
"text": [
13911391
"Provide feedback to cmbagent. Type 'proceed' to continue as suggested or type your suggestion, or type 'exit' to end the conversation: execute\n"
@@ -1499,7 +1499,7 @@
14991499
]
15001500
},
15011501
{
1502-
"name": "stdin",
1502+
"name": "stdout",
15031503
"output_type": "stream",
15041504
"text": [
15051505
"Provide feedback to cmbagent. Type 'proceed' to continue as suggested or type your suggestion, or type 'exit' to end the conversation: exit\n"

0 commit comments

Comments
 (0)