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

Sdg23 update installation quick start page #440

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

namiroues
Copy link
Contributor

To be reviewed by @micaela-matta and @orbeckst.

This PR fixes #385.

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fixes and updates. Please see comments below.


## Conda ##
## Mamba ##
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably still contain the word "conda" because that's what people know.

Suggested change
## Mamba ##
## mamba/conda ##

Comment on lines -12 to -14
If you don't have [conda][] installed yet, follow the [installation
instructions for conda][].

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should still have links to installing mamba/miniforge (see MDAnalysis/UserGuide#361 (comment) ) and conda. There are people who don't use it every day. It's important to give some minimal guidance. It's also a bit odd to recommend mamba but requiring people to somehow have conda already installed.

Comment on lines +25 to +26
MDAnalysis via [mamba][] supports only serial calculations.
For OpenMP-based parallelism, use [pip][] and ensure you have
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still true? @hmacdope ?

@orbeckst orbeckst added the SDG23 work on Small Development Grant 2023 label Feb 28, 2025
@orbeckst
Copy link
Member

I'd say, look at the User Guide: Contributing / with conda-forge packages instructions for mamba installation. We recently rewrote those for the UGM and they look reasonable.

Do NOT follow the standard UG conda installation instructions because they are not correct MDAnalysis/UserGuide#405

@namiroues namiroues force-pushed the sdg23-update-installation-quick-start-page branch from 1ae92cc to 48bad02 Compare February 28, 2025 18:59
@namiroues
Copy link
Contributor Author

Thanks @orbeckst for your comments. I incorporated them. I kept it simple as this is the quick start guide, but happy to take more suggestions as to what level of detail should be included here.

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@jennaswa @micaela-matta do you also want to have a look or should we merge?

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

Successfully merging this pull request may close these issues.

Add mamba to installation quick start guide
2 participants