Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider updating docs to use mamba and Mambaforge #427

Closed
xylar opened this issue May 19, 2023 · 8 comments
Closed

Consider updating docs to use mamba and Mambaforge #427

xylar opened this issue May 19, 2023 · 8 comments
Assignees

Comments

@xylar
Copy link
Contributor

xylar commented May 19, 2023

I would recommend you update the docs to recommend that folks install Mambaforge and use mamba instead of installing Miniconda3 and using conda as the command. mamba is often an order of magnitude or more faster than conda for solving packages. Mambaforge automatically installs mamba and also points to conda-forge, so it saves confusion and potential errors (such as mixing packages from different channels).

@golaz
Copy link
Collaborator

golaz commented May 19, 2023

We have similar documentation pages as well for zstash and E3SM Diags.

@xylar
Copy link
Contributor Author

xylar commented May 20, 2023

Yes, if those pages also still recommend conda and Miniconda, they should be updated similarly.

@forsyth2
Copy link
Collaborator

forsyth2 commented May 22, 2023

I think this is a duplicate (or at least a component) of #397. The equivalent zstash task is E3SM-Project/zstash#252.

@xylar
Copy link
Contributor Author

xylar commented May 22, 2023

@forsyth2, I don't think this is directly related to #397. That is a different workflow. I am referring specifically to https://e3sm-project.github.io/zppy/_build/html/main/getting_started.html#installation-in-a-conda-environment

@forsyth2
Copy link
Collaborator

I figured #397 would cover changing everything over to mamba.

@xylar
Copy link
Contributor Author

xylar commented May 22, 2023

Okay, as long as that's the plan. Please also keep Mambaforge in mind there.

This came up because I was trying to help test ChemDyg and it was not a fun experience when I was using conda, following the docs.

@forsyth2
Copy link
Collaborator

@xylar Do you have anything like the docs mentioned here that use mamba instead of conda? I've never used mamba before and I don't even think I have it installed. (which mamba shows nothing on Chrysalis.)

@xylar
Copy link
Contributor Author

xylar commented May 22, 2023

It needs to be installed explicitly in your base environment if you start with Miniconda3. It comes installed already if you start with Mambaforge (which also makes conda-forge the highest priority channel by default).

Compass and Polaris use mamba extensively and mention it in many places in their docs. Because they included tools for installing it and creating their own conda environments, their docs don't translate one-to-one to zppy and other tools.

If you're uncomfortable make the updates to the docs, I might be able to do it and have you verify that my changes work and make sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants