Wip 4

gisaia · Nov 15, 2024 · 6a3c21e · 6a3c21e
1 parent 89d56ee
commit 6a3c21e
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 4 deletions.
diff --git a/docs/docs/indices.md b/docs/docs/indices.md
@@ -276,7 +276,7 @@ Example:
 !!! note "--bulk"
     Indexing uses bulks for optimal performances. 
 
-    The default size of bulk is 100 and can be changed with the `--bulk` option
+    The default size of bulk is 5000 and can be changed with the `--bulk` option
 
 ## list
 

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -3,10 +3,44 @@
 ## Prerequisite
 
 - python 3.10
-- pip
+- pip 
 
 ## Install
 
+### Python Virtual environment
+
+Particularly on Windows, it is advised to create a python virtual environment with [venv](https://docs.python.org/3.10/library/venv.html#creating-virtual-environments) before installing `arlas_cli`
+
+- Create the environment:
+```shell
+python -m venv env_arlas_cli
+```
+
+- Activate the environment:
+=== "Linux/Mac"
+    ```bash
+    source env_arlas_cli/bin/activate (Can be added to .bashrc or .zshrc)
+    ```
+=== "Windows"
+    with cmd:
+    ```cmd
+    .\env_arlas_cli\Scripts\Activate.bat
+    ```
+    with PowerShell:
+    ```PowerShell
+    .\env_arlas_cli\Scripts\Activate.ps1
+    ```
+
+    !!! tip
+        On Microsoft Windows, it may be required to enable the Activate.ps1 script by setting the execution policy for the user. 
+
+        You can do this by issuing the following PowerShell command:
+        ```PowerShell
+        Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+        ```
+        See [venv documentation](https://docs.python.org/3.10/library/venv.html#creating-virtual-environments) for more information.
+
+### Install arlas_cli
 Install `arlas_cli` with pip:
 
 <!-- termynal -->
@@ -28,7 +62,7 @@ Install `arlas_cli` with pip:
 
 ## Run ARLAS Locally
 
-arlas_cli is meant to interact with a deployed ARLAS stack. 
+`arlas_cli` is meant to interact with a deployed ARLAS stack. 
 
 To run the simplest ARLAS stack and elasticsearch on the local machine, clone the [ARLAS Stack Exploration](https://github.com/gisaia/ARLAS-Exploration-stack) project and run the stack:
 

diff --git a/docs/docs/started.md b/docs/docs/started.md
@@ -8,7 +8,7 @@ To install `arlas_cli`, run the following command from the command line:
 pip install arlas_cli
 ```
 
-For more details, see the [Installation Guide](install.md#installation).
+For more details, in particular for installation on Microsoft Windows, see the [Installation Guide](install.md#installation).
 
 
 ## Configuration