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
Copy file name to clipboardExpand all lines: docs/tools/odm-sdk/installation.md
+119Lines changed: 119 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,3 +30,122 @@ python3 -m pip show --verbose odm-sdk
30
30
```shell
31
31
python3 -m pip uninstall odm-sdk
32
32
```
33
+
34
+
## Troubleshooting
35
+
36
+
### Version mismatch
37
+
38
+
If you encounter an error while working with the SDK, the most common reason is a **version mismatch** between your installed SDK and the ODM.
39
+
40
+
Reinstall the SDK to match the version deployed in your environment:
41
+
42
+
```bash
43
+
python3 -m pip uninstall odm-sdk
44
+
python3 -m pip install odm-sdk==<version>
45
+
```
46
+
47
+
You can verify the currently deployed version by navigating to the ODM homepage.
48
+
49
+
### Check where the SDK is installed
50
+
51
+
If you're unsure which environment your SDK was installed in, or if you're dealing with multiple Python installations, use the following commands:
52
+
53
+
#### macOS / Linux
54
+
55
+
```bash
56
+
python3 -m site
57
+
```
58
+
59
+
Or to see the actual path of the installed SDK:
60
+
61
+
```bash
62
+
pip show odm-sdk
63
+
```
64
+
65
+
Look for the line:
66
+
67
+
```bash
68
+
Location: /path/to/site-packages
69
+
```
70
+
71
+
#### Windows
72
+
73
+
Open Command Prompt or PowerShell and run:
74
+
75
+
```bash
76
+
py -m site
77
+
```
78
+
79
+
Or check the SDK location directly:
80
+
81
+
```bash
82
+
pip show odm-sdk
83
+
```
84
+
85
+
This helps verify whether the SDK was installed in the correct Python environment (e.g. system Python, virtualenv, conda, etc.).
86
+
87
+
### Python environment not visible in `ENV`
88
+
89
+
If you run the `ENV`command (or check environment variables) and don't see your Python environment listed, it may not be properly added to your system's `PATH`.
90
+
91
+
#### How to locate the Python path
92
+
93
+
##### macOS / Linux
94
+
95
+
Use the `which` command:
96
+
97
+
```bash
98
+
which python3
99
+
```
100
+
101
+
Or for pip:
102
+
103
+
```bash
104
+
which pip3
105
+
```
106
+
107
+
This shows the full path of the active Python interpreter or pip binary (e.g., /usr/local/bin/python3).
108
+
109
+
##### Windows
110
+
111
+
Use the where command:
112
+
113
+
```bash
114
+
where python
115
+
```
116
+
117
+
Or:
118
+
119
+
```bash
120
+
where pip
121
+
```
122
+
123
+
This returns the full path to the installed Python executable (e.g., C:\Users\yourname\AppData\Local\Programs\Python\Python310\python.exe)
124
+
125
+
#### Add it to your PATH manually
126
+
127
+
##### macOS / Linux
128
+
129
+
Edit your `~/.bash_profile`, `~/.zshrc`, or `~/.bashrc`:
130
+
131
+
```bash
132
+
export PATH="/path/to/python:$PATH"
133
+
```
134
+
135
+
Then apply the changes:
136
+
137
+
```bash
138
+
source~/.zshrc # or source the correct file for your shell
139
+
```
140
+
141
+
##### Windows
142
+
143
+
1- Open System Properties > Environment Variables
144
+
145
+
2 - Under System variables, selectPath and click Edit
146
+
147
+
3 - Click New and add the path to your Python or Scripts folder (e.g., C:\Python310\Scripts)
148
+
149
+
4 - Click OK and restart your terminal or IDE
150
+
151
+
After updating `PATH`, restart your shell or command prompt to apply the change.
0 commit comments