From f94d77327794d9ec3d625143b5b1a96a31d9e85d Mon Sep 17 00:00:00 2001 From: marc-vdm Date: Fri, 11 Oct 2024 11:01:36 +0200 Subject: [PATCH] update Installation-Guide.md in wiki --- .../docs/wiki/Installation-Guide.md | 72 +++++++++++++++---- 1 file changed, 58 insertions(+), 14 deletions(-) diff --git a/activity_browser/docs/wiki/Installation-Guide.md b/activity_browser/docs/wiki/Installation-Guide.md index 794df2f44..8afe1edbc 100644 --- a/activity_browser/docs/wiki/Installation-Guide.md +++ b/activity_browser/docs/wiki/Installation-Guide.md @@ -14,7 +14,8 @@ You can install and start the activity-browser like this: Skip this step if you already have a working installation of Anaconda or Miniconda, but make sure to keep your conda installation up-to-date: `conda update -n base conda`. -You need the python package manager [Anaconda](https://anaconda.org) to install Activity Browser. +You need the python package manager [Anaconda](https://anaconda.org) to install Activity Browser. +Anaconda is somewhat like an app-store for python programs. You can install the full [Anaconda user interface (navigator)](https://www.anaconda.com/download/success) or just the minimal command-line installer, [Miniconda](https://docs.anaconda.com/miniconda/#miniconda-latest-installer-links). @@ -23,33 +24,76 @@ If needed, see also the or the [Conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/_downloads/843d9e0198f2a193a3484886fa28163c/conda-cheatsheet.pdf). -## Add the Conda-Forge channel -The Activity Browser has many dependencies that are managed by the -[conda-forge](https://conda.io/docs/user-guide/tasks/manage-channels.html) -channel. -Open a cmd-window or terminal (in Windows you may have to use the Anaconda prompt) and type the following: +- Install the Anaconda manager of your choice from the above options. +- Start `Anaconda Prompt` from the start menu. + - This is a terminal window with `conda`, you will need this prompt for all next steps. + +## Add the conda-forge channel +Open an Anaconda prompt window and type the following (and `Enter`): ```bash conda config --prepend channels conda-forge ``` -## Installing Activity Browser -You can now install Activity Browser by creating a python environment (`ab`) +
More information about this step + +Activity Browser has many dependencies that are managed by +[conda-forge](https://conda.io/docs/user-guide/tasks/manage-channels.html). +By adding the channel you can install python packages from there. -Depending on your computer and internet connection, it can take a while for this to complete. -You will need to confirm that you really want to install the environment. +The line above means: +- `conda`: a command for conda +- `config`: change something in the configuration (settings) of `conda` +- `--prepend channels`: in the channels from which conda can install things, add to the top (prepend) +- `conda-forge`: the channel name +
+ +## Creating an environment and Installing Activity Browser +Next, we create a python environment, in which we install Activity Browser ```bash conda create -n ab -c conda-forge activity-browser ``` +> [!NOTE] +> Installing Activity Browser can take some time, this depends on the speed of your internet connection and computer. + +
More information about this step + +We create a separate environment, this allows Activity Browser to work with the specific versions of other libraries +it needs without interfering with other python packages. + +The line above means: +- `conda`: a command for conda +- `create -n ab`: create a new e**n**vironment (`-n`) with the name `ab` +- `-c conda-forge`: from the **c**hannel (`-c`) `conda-forge` +- `activity-browser`: install the package `activity-browser` + +> [!NOTE] +> You can have as many environments as you like, you can also install different versions of Activity Browser +> in different environments, for example for different [plugins](Plugins), or just for using different version of +> Activity Browser. +> +> All environments will have access to the same projects and databases in Activity Browser. +
+ ## Activating and running Activity Browser -To run Activity Browser, you need to activate your environment with -`conda activate ab` and then run activity browser -with `activity-browser`. +To run Activity Browser, you need to activate your environment with +```bash +conda activate ab +``` + +And then run activity browser +with. +```bash +activity-browser +``` Congratulations! You've started Activity Browser for the first time! -# Updating Activity Browser +Every time you want to start Activity Browser, you need to start an anaconda prompt +and do `conda activate ab` and then `activity browser`. + +## Updating Activity Browser We recommend to regularly update Activity Browser to receive new features & bugfixes. These commands will update the Activity Browser and all of its dependencies in the conda environment called `ab`.