Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • N nes
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Jobs
  • Commits
Collapse sidebar
  • Earth SciencesEarth Sciences
  • nes
  • Wiki
  • NES_Installation_Makefile

NES_Installation_Makefile · Changes

Page history
WIP authored May 12, 2025 by Carles Tena's avatar Carles Tena
Hide whitespace changes
Inline Side-by-side
NES_Installation_Makefile.md 0 → 100644
View page @ 9df17807
# NES Installation Guide
This guide provides step-by-step instructions to set up the NES software on MareNostrum5 or locally, using a Makefile.
It includes cloning the repository and running the Makefile to create the Conda environment using Mamba or Conda, configure environment variables, and test the required library imports.
## Table of Contents
- [0. Environment Requirements](#0-environment-requirements)
- [1. Clone Repository](#1-clone-repository)
- [2. Make Installation](#2-make-installation)
- [2.1. Installation for Users](#21-installation-for-users)
- [2.2. Installation for Developers](#22-installation-for-developers)
- [3. Verify Installation](#3-verify-installation)
## 0. Environment Requirements
Ensure you have the following tools installed on your system:
- **Git**: Version control system for cloning the repository.
- **Mamba or Conda**: Package management system to create and manage the environment.
### 0.1 MareNostrum5 Setup
For users on MareNostrum5, load the Earth modules and then the required tools:
```bash
module load git
module load Mamba/23.11.0-0
source activate base
```
## 1. Clone Repository
Clone the NES repository with its submodules:
```bash
cd ${NES_PROJECT_PATH}
git clone https://earth.bsc.es/gitlab/es/nes.git NES
```
## 2. Make Installation
Navigate to the cloned repository and install NES using the provided `Makefile`.
### 2.1 Installation for Users
To perform a standard installation using Mamba:
```bash
cd NES
make full_installation
```
By default, this will:
- Create a Conda environment in `./NES_vX.Y.Z`
- Install all required software
- Set up activation scripts
- Test the installation
#### Optional: Custom installation path
You can change the installation directory with the `CONDA_ENV_DIR` argument:
```bash
make full_installation CONDA_ENV_DIR=/my/custom/path
```
This will create the environment in `/my/custom/path/NES_vX.Y.Z`.
##### MareNostrum5
```bash
make full_installation CONDA_ENV_DIR=/gpfs/projects/bsc32/repository/apps/conda_envs
```
### 2.2 Installation for Developers
To install NES in developer mode (editable install):
```bash
cd NES
make full_installation_for_dev
```
This will create the environment in `./NES_<your-username>` and install the code in editable mode.
#### Optional: Custom path for development install
```bash
make full_installation_for_dev CONDA_ENV_DIR=/my/dev/path
```
This will install the environment in `/my/dev/path/NES_<your-username>`.
##### MareNostrum5
```bash
make full_installation_for_dev CONDA_ENV_DIR=/gpfs/projects/bsc32/repository/apps/conda_envs
```
Clone repository
  • Home
  • Tutorials
  • Trainings
  • Development
  • Contribute
  • FAQ