{"id":3460,"date":"2024-05-03T09:22:41","date_gmt":"2024-05-03T16:22:41","guid":{"rendered":"https:\/\/in.nau.edu\/arc\/?page_id=3460"},"modified":"2024-10-25T15:24:34","modified_gmt":"2024-10-25T22:24:34","slug":"mambaforge-environments","status":"publish","type":"page","link":"https:\/\/in.nau.edu\/arc\/mambaforge-environments\/","title":{"rendered":"Mambaforge – Environments"},"content":{"rendered":"

<\/p>\n

\n\n
\n
<\/p>\n

\n

\n
\n

Contact Advanced Research Computing<\/h3>\n <\/div>\n
\n \n
\n <\/i>\n Email:<\/span>\n <\/div>\n
ask-arc​@nau.edu<\/div>\n <\/a>\n <\/div>\n<\/div>\n\n<\/p>\n

<\/div>\n<\/div>\n\n

Mambaforge – Environments<\/h1>\n

Mamba environments allow you to isolate packages between environments to ensure that the correct dependency versions are used for your programs or scripts. Additionally, environments ensure that there are no dependency and dependency version collisions created due to having a monolithic set of dependencies for everything.<\/p>\n

We also have anaconda3<\/span> available as a module, but we have deliberately chosen mambaforge<\/span> for use within our documentation due to the ability to be a drop-in replacement for Anaconda and for the major improvements listed on the mamba Github page<\/a>, particularly the parallel downloads and faster dependency solving.<\/p>\n

More information on conda\/mamba environments can be found on the Conda documentation page<\/a>. While the main command on that page uses the conda<\/span> command, you can replace it with mamba<\/span> and expect the same results.<\/p>\n

Loading the Mambaforge Module<\/h2>\n

In order to run any mamba<\/span> commands on Monsoon, you must first load the mamba<\/span> executable into your PATH<\/span> by executing the following command:<\/p>\n

module load mambaforge<\/code><\/pre>\n
Once you have loaded the mambaforge<\/span> module, you can check that mamba<\/span> is now available by using the following command:<\/p>\n
mamba --version<\/code><\/pre>\n
Creating an Environment<\/h2>\n
To create a basic environment, use the mamba create<\/span> command:<\/p>\n
mamba create -n [env_name]<\/code><\/pre>\n
You can also specify a specific version of Python.<\/p>\n
mamba create -n [env_name] python=[ver_num]<\/code><\/pre>\n
For example, to create an environment with the name demo_environment<\/span> with Python version 3.10, a mamba create<\/span> command would look like:<\/p>\n
mamba create -n demo_environment python=3.10<\/code><\/pre>\n
\n
Additionally, you can specify where the environment should be located on the filesystem by replacing the -n [env_name]<\/span> flag with \u2010\u2010prefix [directory]<\/span>:<\/p>\n
mamba create --prefix \/scratch\/abc123\/conda_envs\/demo_environment python=3.10<\/code><\/pre>\n
Note: In order to perform actions on an environment in a custom directory such as activating and removing such environment, you must provide the full path to the environment in place of the environment name.<\/em><\/p>\n<\/div>\n
Activating an Environment<\/h2>\n
Once an environment is created, it still needs to be activated in order to use it. This can be done using the mamba activate<\/span> command.<\/p>\n
mamba activate [env_name]<\/code><\/pre>\n
To see what mamba environments are currently available to you, you can use the following command:<\/p>\n
mamba info --envs<\/code><\/pre>\n
For example, to activate the demo_environment<\/span> created in the previous section, a mamba activate<\/span> command would look like:<\/p>\n
mamba activate demo_environment<\/code><\/pre>\n
Once you have activated your environment, your shell prompt will now display the name of the active environment before your regular prompt.<\/p>\n
(demo_environment) [abc123@wind]:~$<\/code><\/pre>\n
Exporting an Environment<\/h2>\n
\n
Exporting environments is particularly useful if you need to move your environment from one location to another, particularly as conda environments can take up a lot of disk space. One such action would be moving an environment from your \/home<\/span> to your \/scratch<\/span> directory.<\/p>\n
To export an environment, use the mamba list<\/span> command and write the output into a file:<\/p>\n
mamba list --explicit > [env_file]<\/code><\/pre>\n
Note: You must first activate your target conda environment. Otherwise, the default conda environment will be exported, which probably isn’t what you are trying to do.<\/em><\/p>\n
For example, to export the active mamba environment to a file called demo_environment_export.txt<\/span>, the commands would look like:<\/p>\n
mamba activate demo_environment\r\nmamba list --explicit > demo_environment_export.txt<\/code><\/pre>\n
Note: Exported mamba environments are platform-dependent. To identify what platform your exported environment will work on, view the 3rd line in your export file containing the platform<\/span> keyword.<\/em><\/p>\n
# platform: linux-64<\/code><\/pre>\n
Note: This export process will only export the installed packages and does not include mamba environment configuration.<\/em><\/p>\n<\/div>\n
Importing an Environment<\/h2>\n
\n
To import an environment, use the mamba create<\/span> command:<\/p>\n
mamba create -n [env_name] --file [env_file]<\/code><\/pre>\n
For example, to import an environment with the target name imported_environment<\/span> from the file demo_environment_export.txt<\/span>, the command would look like:<\/p>\n
mamba create -n imported_environment --file .\/demo_environment_export.txt<\/code><\/pre>\n
Note: Exported conda environments are platform-dependent. To identify what platform your exported environment will work on, view the 3rd line in your export file containing the platform<\/span> keyword.<\/em><\/p>\n
# platform: linux-64<\/code><\/pre>\n
Note: This import process will only import the packages listed in the import file and does not include mamba environment configuration.<\/em><\/p>\n
In order to specify where the conda environment should be imported to, replace the -n<\/span> flag along with the name with \u2010\u2010prefix [path]<\/span>:<\/p>\n
mamba create --prefix \/scratch\/abc123\/conda_envs\/demo_environment --file .\/demo_environment_export.txt<\/code><\/pre>\n
Note: In order to perform actions on an environment in a custom directory such as activating and removing such environment, you must provide the full path to the environment in place of the environment name.<\/em><\/p>\n<\/div>\n
Deactivating an Environment<\/h2>\n
To deactivate an environment, use the following command:<\/p>\n
mamba deactivate<\/code><\/pre>\n
Once you have ran this command, all the programs within the environment that were executable from your PATH<\/span> will no longer be accessible, and any Python scripts ran will no longer use the environment-specific libraries that were previously accessible.<\/p>\n
Additionally, your shell prompt will return back to normal.<\/p>\n
[abc123@wind]:~$<\/code><\/pre>\n
Removing an Environment<\/h2>\n
To remove an environment, use the mamba remove<\/span> command:<\/p>\n
mamba remove -n [env_name] --all<\/code><\/pre>\n
This command will remove the specified environment along with all the packages that were installed inside of it.<\/p>\n
\n
If you installed your environment in a custom directory, use the following command instead:<\/p>\n
mamba remove --prefix [env_dir] --all<\/code><\/pre>\n<\/div>\n
To verify that the environment was removed, you can use the following command and check that your environment is no longer in the list:<\/p>\n
mamba info --envs<\/code><\/pre>\n
Unloading the Mambaforge Module<\/h2>\n
Once you are finished using the mambaforge<\/span> module, you can either exit your shell or run the following command:<\/p>\n
module unload mambaforge<\/code><\/pre>\n
Once you have ran this command, the mamba<\/span> command will no longer be executable as it will be removed from your PATH<\/span>.<\/p>\n
Something to keep in mind is that running this command is that it will NOT automatically deactivate your mamba environments. If you unloaded the mambaforge module before you deactivated the environment, you must first load the\u00a0mambaforge module, deactivate the conda environment, then unload the\u00a0mambaforge module again. Additionally, deactivating an environment after reloading the\u00a0mambaforge module may remove the environment shell prompt. This can be fixed by activating another environment and deactivating it.<\/p>\n<\/div>\n
Setting the Default Environment Location<\/h2>\n
When installing conda packages, you may run into either a permission or a storage issue. To fix this, you will need to define a custom location for your mamba environments.<\/p>\n
To do this, you will need to create and\/or edit the file ~\/.condarc<\/span> using a program such as nano<\/span> with the following contents (feel free to change the directory listed to a better location if it suits you)<\/em>:<\/p>\n
envs_dirs:\r\n  - \/scratch\/<user_id>\/conda\/envs\r\n\r\npkgs_dirs:\r\n  - \/scratch\/<user_id>\/conda\/pkgs\r\n<\/code><\/pre>\n
Note: Make sure you replace <user_id><\/span> with your actual user id.<\/em><\/p>\n
Once the file is present, you should be able to run your mamba<\/span> commands without error. If you get any errors when running mamba<\/span> commands, make sure the syntax is the same as in the example above.<\/p>\n","protected":false},"excerpt":{"rendered":"
Mambaforge – Environments Mamba environments allow you to isolate packages between environments to ensure that the correct dependency versions are used for your programs or scripts. Additionally, environments ensure that there are no dependency and dependency version collisions created due to having a monolithic set of dependencies for everything. We also have anaconda3 available as […]<\/p>\n","protected":false},"author":2758,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_relevanssi_hide_post":"","_relevanssi_hide_content":"","_relevanssi_pin_for_all":"","_relevanssi_pin_keywords":"","_relevanssi_unpin_keywords":"","_relevanssi_related_keywords":"","_relevanssi_related_include_ids":"","_relevanssi_related_exclude_ids":"","_relevanssi_related_no_append":"","_relevanssi_related_not_related":"","_relevanssi_related_posts":"","_relevanssi_noindex_reason":"","ring_central_script_selection":"","footnotes":""},"class_list":["post-3460","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/pages\/3460","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/users\/2758"}],"replies":[{"embeddable":true,"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/comments?post=3460"}],"version-history":[{"count":11,"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/pages\/3460\/revisions"}],"predecessor-version":[{"id":3700,"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/pages\/3460\/revisions\/3700"}],"wp:attachment":[{"href":"https:\/\/in.nau.edu\/arc\/wp-json\/wp\/v2\/media?parent=3460"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}