Update installation - phrasing of titles authored by Bouvry Arnaud's avatar Bouvry Arnaud
**Please read the whole section before starting the install procedure.** **Please read the whole section before starting the install procedure.**
[[_TOC_]]
The recommended installation procedure relies on creating a virtual environment to handle PASE dependencies. The recommended installation procedure relies on creating a virtual environment to handle PASE dependencies.
The repository provides environment files for setting up a conda virtual environment with all necessary dependencies. There are two separate files: The repository provides environment files for setting up a conda virtual environment with all necessary dependencies. There are two separate files:
...@@ -9,7 +7,7 @@ The repository provides environment files for setting up a conda virtual environ ...@@ -9,7 +7,7 @@ The repository provides environment files for setting up a conda virtual environ
- One for Windows users: `environment_windows.yml` - One for Windows users: `environment_windows.yml`
- One for Unix-based systems (macOS and GNU/Linux, such as Ubuntu, Debian, etc.): `environment_unix.yml` - One for Unix-based systems (macOS and GNU/Linux, such as Ubuntu, Debian, etc.): `environment_unix.yml`
# Conda Installation # Installing Conda
If you haven’t installed Conda, we recommend following the [Conda installation guide](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). Here are some options to consider: If you haven’t installed Conda, we recommend following the [Conda installation guide](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). Here are some options to consider:
...@@ -17,7 +15,7 @@ If you haven’t installed Conda, we recommend following the [Conda installation ...@@ -17,7 +15,7 @@ If you haven’t installed Conda, we recommend following the [Conda installation
- **Better option:** Install **Miniconda** for a lighter, customizable setup. - **Better option:** Install **Miniconda** for a lighter, customizable setup.
- **Best option:** Install **Miniforge** (optimized for Conda-forge) and consider using [Mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html), which is faster and more efficient than Conda. - **Best option:** Install **Miniforge** (optimized for Conda-forge) and consider using [Mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html), which is faster and more efficient than Conda.
# Windows Installation # Installing Python modules on Windows
1. Create the `pase` virtual environment: 1. Create the `pase` virtual environment:
...@@ -39,11 +37,11 @@ If you haven’t installed Conda, we recommend following the [Conda installation ...@@ -39,11 +37,11 @@ If you haven’t installed Conda, we recommend following the [Conda installation
4. The framework is now ready for use (for advanced crop modeling, see section [Installing JavaStics](#installing-javastics)). 4. The framework is now ready for use (for advanced crop modeling, see section [Installing JavaStics](#installing-javastics)).
# Unix-based Installation # Installing Python modules on Unix-based systems
**Important notice : for systems running on an arm CPU, the installation procedure is different !** **Important notice : for systems running on an arm CPU, the installation procedure is different !**
## arm CPU installation ## arm CPU systems
Creating the virtual environment from the environment file did not work during testing. The work-around consists in manually installing the required packages and activating a specific configuration option for the **pyembree** install. Creating the virtual environment from the environment file did not work during testing. The work-around consists in manually installing the required packages and activating a specific configuration option for the **pyembree** install.
The commands to run in the terminal are listed below (if you did not install mamba, simply replace "mamba" with "conda" in lines 3 and 5 - untested): The commands to run in the terminal are listed below (if you did not install mamba, simply replace "mamba" with "conda" in lines 3 and 5 - untested):
...@@ -55,7 +53,7 @@ conda config --env --set subdir osx-64 ...@@ -55,7 +53,7 @@ conda config --env --set subdir osx-64
mamba install pyembree mamba install pyembree
``` ```
## All other ## All other systems
1. Create the `pase` virtual environment: 1. Create the `pase` virtual environment:
```bash ```bash
... ...
......