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
Install the core package from the latest release on PyPI:
50
+
51
+
If you wish to use the GUI, which requires [napari](napari:), run instead:
52
+
```sh
53
+
conda install -c conda-forge movement napari pyqt
54
+
```
55
+
You may exchange `pyqt` for `pyside6` if you prefer a different Qt backend.
56
+
See [napari's installation guide](napari:tutorials/fundamentals/installation.html)
57
+
for more details on available backends.
58
+
59
+
:::
60
+
61
+
:::{tab-item} From PyPI using pip
62
+
Install the core package:
45
63
```sh
46
64
pip install movement
47
65
```
48
-
If you wish to use the GUI, which additionally requires [napari](napari:),
49
-
you should instead run:
66
+
If you wish to use the GUI, which requires [napari](napari:), run instead:
50
67
```sh
51
-
pip install movement[napari] # works on most shells
52
-
pip install 'movement[napari]'# works on zsh (default shell on macOS)
68
+
pip install "movement[napari]"
53
69
```
54
70
:::
71
+
72
+
:::{tab-item} From PyPI using uv
73
+
Install the core package:
74
+
```sh
75
+
uv pip install movement
76
+
```
77
+
If you wish to use the GUI, which requires [napari](napari:), run instead:
78
+
```sh
79
+
uv pip install "movement[napari]"
80
+
```
81
+
:::
82
+
55
83
::::
56
84
57
85
:::{dropdown} Note for Apple Silicon users with macOS 13 or earlier
58
86
:color: info
59
87
:icon: info
60
88
61
-
We recommend installing `movement` following the `Conda` instructions above, as the `pip` method will likely fail for you.
62
-
Alternatively, updating your macOS to version 14 or later will allow `pip` installations to work as expected.
89
+
If you are running macOS 13 or earlier on Apple Silicon (M-series) hardware,
90
+
we recommend installing `movement` via `conda-forge`,
91
+
which provides pre-built Qt libraries compatible with macOS 13.
92
+
Alternatively, upgrading to macOS 14 or later enables installation via `pip` or `uv`
93
+
without compatibility issues.
94
+
63
95
:::
64
96
65
-
### Developers
66
-
If you are a developer looking to contribute to movement, please refer to our [contributing guide](target-contributing) for detailed setup instructions and guidelines.
97
+
:::{admonition} For developers
98
+
:class: tip
99
+
100
+
If you plan to contribute to `movement`, see the [contributing guide](target-contributing)
101
+
for detailed developer setup instructions and coding guidelines.
102
+
:::
67
103
68
-
## Check the installation
69
-
To verify that the installation was successful, run (with `movement-env` activated):
104
+
## Verify the installation
105
+
With your virtual environment activated, run:
70
106
```sh
71
107
movement info
72
108
```
73
-
You should see a printout including the version numbers of movement
109
+
You should see a printout including the version numbers of `movement`
74
110
and some of its dependencies.
75
111
76
-
To test the GUI installation, you can run:
112
+
To test the GUI installation:
77
113
78
114
```sh
79
115
movement launch
@@ -83,37 +119,65 @@ This is equivalent to running `napari -w movement` and should open the `napari`
83
119
window with the `movement` widget docked on the right-hand side.
84
120
85
121
## Update the package
86
-
To update `movement` to the latest version, you need to use the same package manager you used to install it (either `conda` or `pip`). If you are not sure which one you used, you can run from your active environment:
122
+
123
+
Always update using the same package manager you used for installation.
124
+
125
+
If you are not sure which one you used, you can run `conda list movement` from your active `conda` environment
126
+
and check whether the output shows `conda-forge` or `pypi` as the channel.
127
+
128
+
To update `movement`, run the appropriate command below:
129
+
130
+
::::{tab-set}
131
+
:::{tab-item} conda
87
132
```sh
88
-
conda list movement
133
+
conda update -c conda-forge movement -y
89
134
```
90
-
If the output shows `conda-forge` as the channel, you used `conda` to install it. If it shows `pypi`, you used `pip`.
135
+
:::
91
136
92
-
Once this is clear, you can update `movement` by running the relevant command from below:
93
-
::::{tab-set}
94
-
:::{tab-item} Conda
137
+
:::{tab-item} pip
95
138
```sh
96
-
conda update movement -y
139
+
pip install -U movement
97
140
```
98
141
:::
99
142
100
-
:::{tab-item} Pip
143
+
:::{tab-item} uv
101
144
```sh
102
-
pip install movement -U
145
+
uv pip install -U movement
103
146
```
104
147
:::
105
148
::::
106
149
107
150
108
-
If the above fails, try installing it in a fresh new environment instead. This should prevent potential compatibility issues caused by changes in dependency versions. You can first uninstall the existing environment named `movement-env`:
151
+
If the above fails, try installing `movement` in a fresh new environment to avoid dependency conflicts.
152
+
153
+
First remove the existing environment:
154
+
155
+
::::{tab-set}
156
+
:::{tab-item} conda
109
157
```sh
110
158
conda env remove -n movement-env
111
159
```
112
-
Once the environment has been removed, you can create a new one following the [installation instructions](#install-the-package) above.
113
160
114
-
:::{tip}
115
-
If you are unsure about the environment name, you can get a list of the environments on your system with:
161
+
This command assumes your environment is named `movement-env`.
162
+
If you are unsure about the name, you can get a list of the environments
163
+
on your system with `conda env list`.
164
+
:::
165
+
166
+
:::{tab-item} uv
167
+
Simply delete the `.venv` folder in your project directory.
168
+
169
+
```bash
170
+
rm -rf .venv # On macOS and Linux
171
+
```
172
+
```powershell
173
+
rmdir /s /q .venv # On Windows PowerShell
174
+
```
175
+
176
+
Optionally, you may also clean the `uv` cache for unused packages:
116
177
```sh
117
-
conda env list
178
+
uv cache prune
118
179
```
119
180
:::
181
+
::::
182
+
183
+
Once the environment has been removed, you can create a new one following the [instructions](#use-a-virtual-environment) above.
0 commit comments