Skip to content

Commit fa83b78

Browse files
committed
Reduce install doc redundancy
Replace redundant install instructions from the install doc by linking to the README. This change removes the need to update install methods in both places. Also, move the Bioformats Conda section to a deprecated section.
1 parent 2c25223 commit fa83b78

File tree

1 file changed

+23
-70
lines changed

1 file changed

+23
-70
lines changed

docs/install.md

Lines changed: 23 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -12,78 +12,11 @@
1212

1313
## Installation Options
1414

15-
### Quick install with Pip
15+
### Quick install
1616

17-
Install MagellanMapper with its graphical interface and registration tools with Python >= 3.10 (see [Python versions](#python-version-support); [virtual environment](https://realpython.com/python-virtual-environments-a-primer/) recommended):
17+
See the [README quick install](https://github.com/sanderslab/magellanmapper/tree/tif_default_instructions?tab=readme-ov-file#quick-install)
1818

19-
```shell
20-
pip install "magellanmapper[most]"
21-
```
22-
23-
Then launch MagellanMapper:
24-
25-
```shell
26-
mm
27-
```
28-
29-
Note: MM <1.7a1 installed import packages with `most`. For these versions, install with this command instead: `pip install "magellanmapper[gui,itk]"`
30-
31-
See [below](#dependencies) for supported Python versions and adding install groups.
32-
33-
See our [vignette](https://github.com/sanderslab/magellanmapper/blob/master/bin/sample_cmds_bash.ipynb) for getting started on MM!
34-
35-
### Quick install with Conda
36-
37-
If you use Conda (available [here](https://docs.conda.io/en/latest/miniconda.html)), you can install MagellanMapper into a new environment named `mag` (or replace with desired name):
38-
39-
```shell
40-
conda env create -n mag -f https://raw.githubusercontent.com/sanderslab/magellanmapper/master/envs/environment_rel.yml
41-
```
42-
43-
To run, activate the environment and launch MagellanMapper by `mm`:
44-
45-
```shell
46-
conda activate mag
47-
mm
48-
```
49-
50-
### Developer installs
51-
52-
You can install directly from the source code, which lets you use the latest updates without reinstallation.
53-
54-
First, download the repo:
55-
56-
```shell
57-
git clone https://github.com/sanderslab/magellanmapper.git
58-
```
59-
60-
Next, install it with Conda:
61-
62-
```shell
63-
conda env create -n mag -f magellanmapper/environment.yml
64-
```
65-
66-
or with Pip:
67-
68-
```shell
69-
pip install -e "magellanmapper[most]"
70-
```
71-
72-
MagellanMapper can be run as above.
73-
74-
**Alternative:** Install with all extra packages in Conda. Java will be installed automatically in Conda to support more image formats.
75-
76-
```shell
77-
conda env create -n mag -f magellanmapper/environment_all.yml
78-
```
79-
80-
Or with Pip. Java needs to be installed before MM. Download Java from [here](https://www.azul.com/downloads/?package=jdk).
81-
82-
```shell
83-
pip install -e "magellanmapper[all]" --extra-index-url https://pypi.fury.io/dd8/
84-
```
85-
86-
The `all` group installs the GUI and file import tools (see [optional dependencies below](#optional-installation-groups)). The extra index accesses a few [customized dependencies](#custom-packages) for MagellanMapper.
19+
Python >= 3.10 supported. See below for [Python versions](#python-version-support) and adding [install groups]((#dependencies)). [Virtual environment](https://realpython.com/python-virtual-environments-a-primer/) recommended).
8720

8821
### Optional installation groups
8922

@@ -111,6 +44,26 @@ pip install -e ".[3d,gui]" # add two groups
11144

11245
As of MM 1.6a2, the GUI can be excluded by installing the base group, eg without `[gui]` or `[most]`.
11346

47+
### DEPRECATED: Install Bioformats/Javabridge support
48+
49+
<details>
50+
51+
Install with all extra packages in Conda. Java will be installed automatically in Conda to support more image formats.
52+
53+
```shell
54+
conda env create -n mag -f magellanmapper/environment_all.yml
55+
```
56+
57+
Or with Pip. Java needs to be installed before MM. Download Java from [here](https://www.azul.com/downloads/?package=jdk).
58+
59+
```shell
60+
pip install -e "magellanmapper[all]" --extra-index-url https://pypi.fury.io/dd8/
61+
```
62+
63+
The `all` group installs the GUI and file import tools (see [optional dependencies below](#optional-installation-groups)). The extra index accesses a few [customized dependencies](#custom-packages) for MagellanMapper.
64+
65+
</details>
66+
11467
### DEPRECATED: Installer packages
11568

11669
<details>

0 commit comments

Comments
 (0)