Skip to content

WEB: Use mambaforge for the getting started installation instructions? #48220

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

Merged
merged 5 commits into from
Aug 30, 2022

Conversation

MarcoGorelli
Copy link
Member

Also doing some other assorted minor doc changes whilst here

* Install either `Anaconda <https://www.anaconda.com/products/individual>`_, `miniconda
<https://docs.conda.io/en/latest/miniconda.html>`_, or `miniforge <https://github.com/conda-forge/miniforge>`_
* Make sure your conda is up to date (``conda update conda``)
* Install `mamba <https://mamba.readthedocs.io/en/latest/index.html>`_
Copy link
Member

Choose a reason for hiding this comment

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

There are some references to conda in the section above this one. Should those also be changed or maybe linked directly to this section for clarity?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, good point, thanks

the mamba docs have conda activate, but mamba activate also works fine, I've replaced conda with mamba throughout to avoid confusion

Copy link
Member

Choose a reason for hiding this comment

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

I'd personally use this link to install mamba: https://github.com/conda-forge/miniforge#mambaforge

In my opinion this is what users should use, and it's not so obvious to find. Users may end up installing Anaconda, to then install mamba... which doesn't sound ideal.

But if you have a preference for the mamba home docs, also fine with it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah agree that that's what people should use - it's the first link to show up on https://mamba.readthedocs.io/en/latest/installation.html , so let's link that (which'll probably be the most up-to-date reference)?

@mroeschke mroeschke added this to the 1.6 milestone Aug 25, 2022
@MarcoGorelli
Copy link
Member Author

@datapythonista seeing as you'd opened the issue - any objections here?

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Thanks @MarcoGorelli for working on this, nice improvement. Left couple of ideas, but happy to get this merged regardless.

We've also got this page in the website that we should update: https://pandas.pydata.org/getting_started.html. But better in a separate PR, I can do it if you prefer.

* Install either `Anaconda <https://www.anaconda.com/products/individual>`_, `miniconda
<https://docs.conda.io/en/latest/miniconda.html>`_, or `miniforge <https://github.com/conda-forge/miniforge>`_
* Make sure your conda is up to date (``conda update conda``)
* Install `mamba <https://mamba.readthedocs.io/en/latest/index.html>`_
Copy link
Member

Choose a reason for hiding this comment

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

I'd personally use this link to install mamba: https://github.com/conda-forge/miniforge#mambaforge

In my opinion this is what users should use, and it's not so obvious to find. Users may end up installing Anaconda, to then install mamba... which doesn't sound ideal.

But if you have a preference for the mamba home docs, also fine with it.


# or with older versions of Anaconda:
source activate pandas-dev
mamba env create -f environment.yml
Copy link
Member

Choose a reason for hiding this comment

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

The -f environment.yml is not needed. I remember someone wanted to have it anyway at that time (not sure why), but if that's not the case anymore, I'd remove it and make things simpler.

@mroeschke mroeschke merged commit 3a3ed66 into pandas-dev:main Aug 30, 2022
@mroeschke
Copy link
Member

Thanks @MarcoGorelli. Happy to have the followups in another PR

@mroeschke mroeschke modified the milestones: 1.6, 2.0 Oct 13, 2022
@MarcoGorelli
Copy link
Member Author

@meeseeksdev backport 1.5.x

@MarcoGorelli
Copy link
Member Author

backporting as this doesn't show up in the docs

@lumberbot-app
Copy link

lumberbot-app bot commented Oct 20, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 1.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 3a3ed661c0a62b97f6fffc05bbf1fe6769b908cc
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #48220:  WEB: Use mambaforge for the getting started installation instructions?'
  1. Push to a named branch:
git push YOURFORK 1.5.x:auto-backport-of-pr-48220-on-1.5.x
  1. Create a PR against branch 1.5.x, I would have named this PR:

"Backport PR #48220 on branch 1.5.x ( WEB: Use mambaforge for the getting started installation instructions?)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

MarcoGorelli pushed a commit to MarcoGorelli/pandas that referenced this pull request Oct 20, 2022
MarcoGorelli pushed a commit to MarcoGorelli/pandas that referenced this pull request Oct 20, 2022
MarcoGorelli added a commit that referenced this pull request Oct 21, 2022
…llation instructions? (#49211)

Co-authored-by: MarcoGorelli <>
noatamir pushed a commit to noatamir/pandas that referenced this pull request Nov 9, 2022
…s? (pandas-dev#48220)

* recommend mamba

* replace conda with mamba

* use mamba reference

* remove unnecessary -f environment.yml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WEB: Use mambaforge for the getting started installation instructions?
3 participants