Skip to content
Snippets Groups Projects

Docs conda instructions

Merged s184058 requested to merge docs_conda_instructions into main
2 files
+ 59
2
Compare changes
  • Side-by-side
  • Inline

Files

+ 57
1
@@ -38,7 +38,60 @@ Whether you are working with medical imaging data, materials science data, or an
@@ -38,7 +38,60 @@ Whether you are working with medical imaging data, materials science data, or an
## Installation
## Installation
Creating an `conda` environment is not required but recommended:
Creating a `conda` environment is not required but recommended.
 
 
 
??? info "Miniconda installation and setup"
 
 
[Miniconda](https://docs.anaconda.com/free/miniconda/index.html) is a free minimal installer for conda.
 
 
Here are some quick command line instructions to help you set up the latest Miniconda installer promptly. For graphical installers (.exe and .pkg) and instructions on hash checking, please refer to [Installing Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/).
 
 
=== "Windows"
 
These three commands quickly and quietly install the latest 64-bit version of the installer and then clean up after themselves. To install a different version or architecture of Miniconda for Windows, change the name of the `.exe` installer in the `curl` command.
 
 
```bash
 
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda.exe
 
start /wait "" miniconda.exe /S
 
del miniconda.exe
 
```
 
After installing, open the “Anaconda Prompt (miniconda3)” program to use Miniconda3. For the Powershell version, use “Anaconda Powershell Prompt (miniconda3)”.
 
 
=== "macOS"
 
These four commands quickly and quietly install the latest M1 macOS version of the installer and then clean up after themselves. To install a different version or architecture of Miniconda for macOS, change the name of the `.sh` installer in the `curl` command.
 
 
```bash
 
mkdir -p ~/miniconda3
 
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o ~/miniconda3/miniconda.sh
 
bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
 
rm -rf ~/miniconda3/miniconda.sh
 
```
 
 
After installing, initialize your newly-installed Miniconda. The following commands initialize for bash and zsh shells:
 
 
```bash
 
~/miniconda3/bin/conda init bash
 
~/miniconda3/bin/conda init zsh
 
```
 
 
=== "Linux"
 
These four commands quickly and quietly install the latest 64-bit version of the installer and then clean up after themselves. To install a different version or architecture of Miniconda for Linux, change the name of the `.sh` installer in the `wget` command.
 
 
```bash
 
mkdir -p ~/miniconda3
 
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
 
bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
 
rm -rf ~/miniconda3/miniconda.sh
 
```
 
 
After installing, initialize your newly-installed Miniconda. The following commands initialize for bash and zsh shells:
 
 
```bash
 
~/miniconda3/bin/conda init bash
 
~/miniconda3/bin/conda init zsh
 
```
 
Once you have `conda` installed, create a new enviroment:
 
```
```
conda create -n qim3d python=3.11
conda create -n qim3d python=3.11
```
```
@@ -48,6 +101,9 @@ conda activate qim3d
@@ -48,6 +101,9 @@ conda activate qim3d
```
```
 
 
 
### Install using `pip`
### Install using `pip`
The latest stable version can be simply installed using `pip`:
The latest stable version can be simply installed using `pip`:
Loading