Skip to content

Commit 56d5727

Browse files
Maxcode123Maxcode123
committed
Updates installation docs
1 parent eb2d243 commit 56d5727

1 file changed

Lines changed: 56 additions & 2 deletions

File tree

‎docs/installation.md‎

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,65 @@
22

33
You'll need Python installed to install `micromanager`.
44

5+
## pipx (recommended)
6+
7+
You can find instructions on how to install pipx [here](https://github.com/pypa/pipx)
8+
9+
```sh
10+
pipx install compose-micromanager
11+
```
12+
13+
The above command should install the `micromanager` executable in your environment.
14+
Try it out by running `micromanager` in the terminal:
15+
16+
```sh
17+
> micromanager
18+
Usage: micromanager [OPTIONS] COMMAND [ARGS]...
19+
20+
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
21+
│ --install-completion Install completion for the current shell. │
22+
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
23+
│ --help Show this message and exit. │
24+
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
25+
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
26+
│ start Start the given projects by running compose up. If the projects argument is empty, starts all projects of the current system. │
27+
│ use Set the given system as your current working system. │
28+
│ config Display the current configuration. │
29+
│ stop Stop the given projects by running compose down. If the projects argument is empty, stops all projects of the current system. │
30+
│ status Print the status of all configured projects in the current system. │
31+
│ restart Restart the given projects by running compose restart. If the projects argument is empty, restarts all projects of the current system. │
32+
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
33+
```
34+
535
## pip
636

37+
It is recommended to use virtual environments when installing Python packages. If
38+
you're not sure how to use them, opt for the first option (pipx).
39+
If you want to know more about virtual environments you can read [this](https://docs.astral.sh/uv/pip/environments/).
40+
741
```sh
842
pip install compose-micromanager
943
```
1044

11-
The above will install the `micromanager` executable in your environment.
12-
To validate that micromanager is installed run `micromanager --help`.
45+
The above will install the `micromanager` executable in your current
46+
Python environment.
47+
To validate that micromanager is installed you have to activate the environment in which micromanager is installed and run `micromanager`.
48+
49+
```sh
50+
> micromanager
51+
Usage: micromanager [OPTIONS] COMMAND [ARGS]...
52+
53+
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
54+
│ --install-completion Install completion for the current shell. │
55+
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
56+
│ --help Show this message and exit. │
57+
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
58+
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
59+
│ start Start the given projects by running compose up. If the projects argument is empty, starts all projects of the current system. │
60+
│ use Set the given system as your current working system. │
61+
│ config Display the current configuration. │
62+
│ stop Stop the given projects by running compose down. If the projects argument is empty, stops all projects of the current system. │
63+
│ status Print the status of all configured projects in the current system. │
64+
│ restart Restart the given projects by running compose restart. If the projects argument is empty, restarts all projects of the current system. │
65+
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
66+
```

0 commit comments

Comments
 (0)