Tutorial showing how to manage Conda environments in a Project Space on Cheaha

docs/cheaha/tutorial/using_conda_project_space.md

@@ -0,0 +1,110 @@
+# Using Conda in a Project Space on Cheaha
+
+This tutorial will guide you through setting up and using a Conda environment in a project space on Cheaha. In this tutorial we use Miniforge3, a minimal installer for Conda, which will simplify the environment setup and management. For this tutorial, we are creating a new Conda environment, activating it, and installing two Conda packages.
+
+## Load the Miniforge3 Module
+
+Next, log in to Cheaha, and gain access to a Compute Node using the Terminal. There are detailed instructions [here](../getting_started.md#login-vs-compute-nodes). When in a compute node, load the Miniforge3 module to use Conda:
+
+```bash
+module load Miniforge3
+```
+
+![!Loading the Miniforge3 Module on a Cheaha Compute Node](images/module_load_miniforge.png)
+
+## Create a Conda folder in your Project Space on Cheaha
+
+**Navigate to the shared location where you want to create your Conda folder. Make sure that this location has the necessary permissions for all collaborators:**
+
+```bash
+cd /data/project/chosen/shared/location
+```
+
+![!Navigating to your project space on Cheaha](images/cheaha_project_space.png)
+
+**Create the Conda folder:**
+
+```bash
+mkdir conda_project
+
+cd conda_project
+```
+
+![!Creating a directory for your conda files](images/created_conda_directory.png)
+
+**You may need to adjust the permissions to ensure the folder is accessible by all members of your project space on Cheaha:**
+
+```bash
+chmod -R 770 conda_project
+```
+
+![!Granting all members of the project space access to the Conda directory](images/create_access_group.png)
+
+This command grants read, write, and execute permissions to the user and group (i.e. You as owner of the project space on Cheaha, as well as members of your project space), this will allow members of your project space on Cheaha access, and restrict others.
+
+## Initialize Conda
+
+To create a Conda environment that can be shared with members of your project space, we use the command below to initialize Conda in the folder location:
+
+```bash
+conda config --add envs_dirs /data/project/preferred/shared/location/conda_project/envs
+```
+
+![!Creating conda directories inside your folder](images/add_conda_config_directory.png)
+
+This command sets the Conda environment directory to the shared folder within your project space on Cheaha.
+
+## Create a Conda Environment in the Shared Folder
+
+Now, create a new Conda environment in the shared project folder:
+
+```bash
+conda create --prefix /data/project/preferred/shared/location/conda_project/envs/my_env python=3.11
+```
+
+![!Command showing the creation of A Conda env with the prefix flag](images/conda_prefix_env.png)
+
+Replace `/data/project/preferred/shared/location/conda_project/envs/my_env` with the path to your shared folder and `python=3.11` with the desired version of Python or any other package you want to install. This will create a Conda environment named `my_env`. This can be replaced with an environment name of your choosing.
+
+Activate the environment:
+
+```bash
+conda activate /data/project/chosen/shared/location/conda_project/envs/my_env
+```
+
+![!Command showing activation of A Conda env from a project space on Cheaha](images/conda_activate.png)
+
+## Install Packages in the Conda Environment
+
+Once the environment is activated, install any necessary packages:
+
+```bash
+conda install <package name>
+```
+
+In this example we installed the following packages;
+
+```bash
+conda install numpy matplotlib
+```
+
+![!Command installing Conda packages within the activated env file in the project space on Cheaha](images/conda_install_packages.png)
+
+You can replace `numpy matplotlib` with the name(s) of package(s) required for your project. When you're done working, deactivate the environment:
+
+```bash
+conda deactivate
+```
+
+## Share the Environment with Collaborators
+
+Share the location of the Conda environment ( `env` ) with your collaborators, and the below steps will activate that environment. They must load the Miniforge3 module before they can activate the environment in the project space:
+
+```bash
+module load Miniforge3
+conda activate /path/to/shared/location/my_project/envs/my_env
+```
+
+## Managing the Conda Environment
+
+We have [documentation](../../workflow_solutions/using_anaconda.md#using-anaconda) on managing Conda environments within your personal Cheaha account. That guide also applies to managing environments in a shared project space on Cheaha.

mkdocs.yml

@@ -96,9 +96,9 @@ nav:
  - Storage Alternatives: data_management/alternate_storage.md
  - Long Term Storage:
  - data_management/lts/index.md
- - Tutorial: 
-  - data_management/lts/tutorial/index.md
-  - LTS and s3cmd Workflow: data_management/lts/tutorial/individual_lts_tutorial.md
+ - Tutorial:
+ - data_management/lts/tutorial/index.md
+ - LTS and s3cmd Workflow: data_management/lts/tutorial/individual_lts_tutorial.md
  - Interfacing with LTS: data_management/lts/interfaces.md
  - Bucket Permissions: data_management/lts/policies.md
  - UAB Core Accounts: data_management/lts/lts_cores.md
@@ -121,6 +121,7 @@ nav:
  - Tutorials:
  - cheaha/tutorial/index.md
  - Anaconda Environment Tutorial: cheaha/tutorial/pytorch_tensorflow.md
+ - Using Conda in a Project Space on Cheaha: cheaha/tutorial/using_conda_project_space.md
  - Cheaha Web Portal:
  - cheaha/open_ondemand/index.md
  - Using the Web Portal: cheaha/open_ondemand/ood_layout.md