From e1829f05301426d42a9e74c93ef83d9a5ddf539e Mon Sep 17 00:00:00 2001 From: teekuningas Date: Fri, 3 May 2024 11:36:56 +0300 Subject: [PATCH] Update getting-started.md to include conda installation instructions --- docs/user-guide/getting-started.md | 33 ++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/getting-started.md b/docs/user-guide/getting-started.md index 4e3c54ed..d90c1d1a 100644 --- a/docs/user-guide/getting-started.md +++ b/docs/user-guide/getting-started.md @@ -4,12 +4,36 @@ Meggie does not have standalone installers, but it can be easily installed on Wi ## Using conda -Install meggie to a conda environment: +### Installing miniconda + +If conda is not already installed on your system, follow these steps: + +1. Visit the Miniconda download page: [https://docs.conda.io/projects/conda](https://docs.conda.io/projects/conda) + +2. Download the appropriate installer for your operating system: + + - **Windows**: Miniconda3-latest-Windows-x86_64.exe + - **Linux**: Miniconda3-latest-Linux-x86_64.sh + - **macOS**: Miniconda3-latest-MacOSX-x86_64.pkg + +3. Run the downloaded installer and follow the on-screen instructions to complete the installation. + +### Opening the Anaconda Prompt + +- **Windows**: After installation, you can access the Anaconda Prompt from the Start Menu. This opens a terminal window with conda commands available. + +- **Linux/macOS**: During installation, Miniconda updates the `.zshrc` or `.bashrc` file (depending on your default shell). Use the standard terminal application, and you may need to open a new terminal window to access the conda commands. The prompt should display “(base)” to indicate that conda is active. + +### Installing Meggie + +Install Meggie in a conda environment: ```bash $ conda create -n meggie-env -c conda-forge --solver libmamba meggie=={{VERSION}} ``` -### Using pip: +## Using pip: + +Alternatively, if you have a standard python installation, you can directly use venv and pip to install Meggie in a virtual environment. Create a virtual environment folder: ```bash @@ -23,11 +47,12 @@ Install dependencies: ```bash $ pip install -r https://raw.githubusercontent.com/cibr-jyu/meggie/v{{VERSION}}/requirements.txt ``` -Install meggie: +Install Meggie: ```bash pip install meggie=={{VERSION}} ``` -# Starting meggie for the first time + +# Starting Meggie for the first time Activate the environment in which Meggie was installed. For conda: ```bash conda activate meggie-env