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.

Sign up for GitHub

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

Jump to bottom

Update installation instructions to use miniforge/mamba #491

Merged
merged 3 commits into from
Sep 30, 2024
Merged

Update installation instructions to use miniforge/mamba #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b479e81
Miniforge edits part 1
ktyle Sep 30, 2024
8a391a8
Eliminate Anaconda distribution references
ktyle Sep 30, 2024
66ccdbf
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions foundations/conda.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,17 @@ Package management is useful because you may want to update a package for one of

## Installing Conda

We recommend you install Miniconda. You can do that by following the [instructions for your machine](https://docs.conda.io/en/latest/miniconda.html).
We recommend you install Miniforge. You can do that by following the [instructions for your machine](https://github.com/conda-forge/miniforge).

Miniconda only comes with the `conda` package management system; it is a pared-down version of the full Anaconda Python distribution.
Miniforge uses the `conda` package management system and is based on Miniconda, which is a pared-down version of the full Anaconda Python distribution.

[Installing Anaconda](https://docs.anaconda.com/anaconda/install/) takes longer and uses up more disk space, but provides you with more functionality, including Spyder (a Python-specific integrated development environment or IDE) and Jupyter, in addition to other immediately installed packages. Also, the interface of Anaconda is great if you are uncomfortable with the terminal.

We recommend Miniconda for two reasons:
We recommend Miniforge for these reasons:

1. It's quicker and takes up less disk space.
2. It encourages you to install only the packages you need in reproducible isolated environments for specific projects. This is generally a more robust way to work with open source tools.
3. It uses `conda-forge` as the default channel for packages.
Copy link
Member

Choose a reason for hiding this comment

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

This is great, but might not mean much to the newbie. Here's my suggested addition:

Suggested change
3. It uses `conda-forge` as the default channel for packages.
3. It uses `conda-forge` as the default channel, which is our recommended way to get up-to-date, interoperable packages.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oops, looks like I clicked the merge button too quickly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no prob, i'll commit and merge the suggestion by @brian-rose.


Once you have `conda` via the Miniconda installer, the next step is to create an environment and install packages.

Expand Down
11 changes: 4 additions & 7 deletions foundations/jupyter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You'd like to learn to run Python in a Jupyter session. Here we will cover:

To run a Jupyter session, you will need to install some necessary packages into your Conda environment.

Install `miniconda` by following the [instructions for your machine](https://docs.conda.io/en/latest/miniconda.html).
Install `miniforge` by following the [instructions for your machine](https://github.com/conda-forge/miniforge).

[Learn more about Conda here](conda.md)

Expand All @@ -41,11 +41,7 @@ $ conda activate pythia_foundations_env
$ jupyter lab
```

Or you can install the full [Anaconda](https://www.anaconda.com/products/distribution), and select **LAUNCH** under the Jupyter panel in the GUI.

![Anaconda Navigator](../images/Anaconda.png)

In both methods, a new window should open automatically in your default browser. You can change the browser when launching from the terminal with (for example):
A new window should open automatically in your default browser. You can change the browser when launching from the terminal with (for example):

```
jupyter lab —browser=chrome
Expand Down Expand Up @@ -121,4 +117,5 @@ Jupyter notebooks are a free, open-source, interactive tool running inside a web

## Resources and References

- [Anaconda](https://www.anaconda.com/products/distribution)
- [conda-forge](https://conda-forge.org)
- [Miniforge Releases](https://conda-forge.org/miniforge/)
2 changes: 1 addition & 1 deletion foundations/terminal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You'd like to learn to run Python in the terminal. Here we will cover:

## Installing Python in the Terminal

If you are running Python in the terminal, it is best to install Miniconda. You can do that by following the [instructions for your machine](https://docs.conda.io/en/latest/miniconda.html).
If you are running Python in the terminal, it is best to install Miniforge. You can do that by following the [instructions for your machine](https://github.com/conda-forge/miniforge).

[Learn more about Conda here](conda.md)

Expand Down
Loading