Skip to content

Commit e362e3f

Browse files
brian-roser-ford
andauthored
Remove Miniconda, improve Glossary for Miniforge and conda-forge (#641)
* Better glossary tie-ins for conda stuff * Update appendix/glossary.md Co-authored-by: Robert Ford <50349951+r-ford@users.noreply.github.com> --------- Co-authored-by: Robert Ford <50349951+r-ford@users.noreply.github.com>
1 parent aac695e commit e362e3f

3 files changed

Lines changed: 18 additions & 18 deletions

File tree

appendix/glossary.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,12 @@ commit
3232
: A snapshot of your Git repository at a specific time.
3333

3434
conda
35-
: Conda is an open-source, cross-platform, language-agnostic package manager and environment management system that allows you to quickly install, run, and update packages within your work environment(s). To install `conda`, we recommend {term}`miniconda`.
35+
: Conda is an open-source, cross-platform, language-agnostic package manager and environment management system that allows you to quickly install, run, and update packages within your work environment(s). To install conda, we recommend {term}`Miniforge`.
3636
: See [conda documentation](https://docs.conda.io/en/latest/), particularly the [conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/user-guide/cheatsheet.html), and @conda-commands in the context of Project Pythia.
3737

38+
conda-forge
39+
: conda-forge is a large, community-organized collection of software packages that can be installed on a wide variety of computing platforms via the {term}`conda` package manager. It is our recommended installation source for Python itself as well as most packages in the {term}`scientific Python ecosystem`.
40+
3841
DevOps
3942
: The integration and automation of practices and processes for software development and operations.
4043

@@ -88,12 +91,9 @@ local
8891
merge
8992
: A specific type of commit that combines changes from two branches.
9093

91-
Miniconda
92-
: [Miniconda](https://docs.conda.io/en/latest/miniconda.html) is a free minimal installer for {term}`conda`. Miniconda only comes with the {term}`conda` package management system; it is a pared-down version of the full Anaconda Python distribution.
93-
: See @installing-conda.
94-
9594
Miniforge
96-
: Miniforge is the community driven and more permissively licensed minimal installer.
95+
: [Miniforge](https://github.com/conda-forge/miniforge) is a free minimal installer for {term}`conda`. Miniforge includes the {term}`conda` package management system, and is pre-configued to install packages from the {term}`conda-forge` repository. Miniforge is community-driven and permissively licensed.
96+
: See @installing-conda.
9797

9898
[NCL](https://www.ncl.ucar.edu/)
9999
: The NCAR Command Language (NCL) is an interpreted language designed specifically for scientific data analysis and visualization.
@@ -120,7 +120,7 @@ remote
120120
: A repository hosted on a server such as {term}`GitHub`.
121121

122122
scientific Python ecosystem
123-
: A collection of open source Python packages that support analysis, manipulation, and visualization of scientific data.
123+
: A collection of open source {term}`Python package`s that support analysis, manipulation, and visualization of scientific data.
124124

125125
upstream
126126
: The project repository from which a fork was created.

foundations/conda.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You may have encountered a few different package managers in the Python world:
3535
- [pixi](https://pixi.prefix.dev/latest/) and [uv](https://docs.astral.sh/uv/) are newer options that are gaining popularity&mdash;well worth exploring for the adventurous learner!
3636
- {term}`conda` is widely used for scientific computing, and this is what we recommend.
3737

38-
A key advantage of {term}`conda` over pip is that it manages all types of package requirements, not just Python packages. The most reliable source of up-to-date, interoperable scientific packages are found in the community-maintained `conda-forge` repository (see below).
38+
A key advantage of {term}`conda` over pip is that it manages all types of package requirements, not just Python packages. The most reliable source of up-to-date, interoperable scientific packages are found in the community-maintained {term}`conda-forge` repository (see below).
3939

4040
:::{tip} TL;DR
4141
We strongly recommend using {term}`conda` to install and manage Python and all your complex project-specific software.
@@ -45,7 +45,7 @@ We strongly recommend using {term}`conda` to install and manage Python and all y
4545

4646
## Installing conda
4747

48-
We recommend you start by [installing](https://conda-forge.org/download/) [Miniforge](https://github.com/conda-forge/miniforge). This is a specific version of the {term}`conda` package manager pre-configured to work with the `conda-forge` package repository&mdash;our recommended source for most of the packages you will need.
48+
We recommend you start by [installing](https://conda-forge.org/download/) [Miniforge](https://github.com/conda-forge/miniforge). This is a specific version of the {term}`conda` package manager pre-configured to work with the {term}`conda-forge` package repository&mdash;our recommended source for most of the packages you will need.
4949

5050
You can install Miniforge by following the [instructions for your machine](https://github.com/conda-forge/miniforge#install).
5151

@@ -57,14 +57,14 @@ A few reasons why we recommend installing Miniforge:
5757

5858
1. It's free, lightweight, and won't interfere with other installations on your computer.
5959
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.
60-
3. It uses `conda-forge` as the default channel for packages, which is our recommended way to get up-to-date, interoperable packages.
60+
3. It uses {term}`conda-forge` as the default channel for packages, which is our recommended way to get up-to-date, interoperable packages.
6161

62-
Once you have `conda` via the Miniconda installer, the next step is to create an environment and install packages.
62+
Once you have {term}`conda` via the {term}`Miniforge` installer, the next step is to create an environment and install packages.
6363

6464
:::{note}
6565
Users looking for a full-featured commercially licensed and supported Python environment manager should take a look at [Anaconda](https://www.anaconda.com/), which may be [free for academic usage](https://www.anaconda.com/blog/update-on-anacondas-terms-of-service-for-academia-and-research).
6666

67-
The conda package manager and our recommended Miniforge installation are open source and free for all users.
67+
The conda package manager and our recommended Miniforge installation are open source, community-supported and free for all users.
6868
:::
6969

7070
## Creating a conda environment
@@ -137,8 +137,8 @@ Some other {term}`conda` commands that you will find useful include:
137137

138138
You can find lots more information in the [conda documentation](https://docs.conda.io/en/latest/) or this handy [conda cheat sheet](https://docs.conda.io/projects/conda/en/stable/user-guide/cheatsheet.html#cheatsheet).
139139

140-
:::{tip} What if the package you need is not available from `conda-forge`?
141-
If the package you are trying to use (`somepackage` in these examples) only mentions `pip install somepackage` in its docs, or you tried `conda install somepackage` and conda couldn't find it, it is likely that this package is not available via the `conda-forge` channel.
140+
:::{tip} What if the package you need is not available from {term}`conda-forge`?
141+
If the package you are trying to use (`somepackage` in these examples) only mentions `pip install somepackage` in its docs, or you tried `conda install somepackage` and conda couldn't find it, it is likely that this package is not available via the {term}`conda-forge` channel.
142142

143143
As a plan B, after activating your custom conda environment you can install using pip like this:
144144
```
@@ -167,5 +167,5 @@ We recommend installing {term}`conda` via [Miniforge](https://github.com/conda-f
167167
- [Linux commands](https://cheatography.com/davechild/cheat-sheets/linux-command-line/)
168168
- [conda documentation](https://docs.conda.io/en/latest/)
169169
- [conda cheat sheet](https://docs.conda.io/projects/conda/en/stable/user-guide/cheatsheet.html#cheatsheet)
170-
- [Anaconda](https://docs.anaconda.com/anaconda/install/)
171-
- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
170+
- [Miniforge](https://github.com/conda-forge/miniforge)
171+
- [conda-forge](https://conda-forge.org)

foundations/terminal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You'd like to learn to run Python in the terminal. Here we will cover:
2121

2222
## Installing Python in the Terminal
2323

24-
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).
24+
If you are running Python in the terminal, it is best to install {term}`Miniforge`. You can do that by following the [instructions for your machine](https://github.com/conda-forge/miniforge).
2525

2626
:::{tip}For Windows users
2727
When [installing Miniforge using the Windows installer](https://conda-forge.org/download/), make sure to check "Create start menu shortcuts (supported packages only)". Then in your start menu or search box, you will find the "Miniforge Prompt", where you will enter commands.
@@ -31,7 +31,7 @@ When [installing Miniforge using the Windows installer](https://conda-forge.org/
3131
More details about conda are provided in a later section ([Installing and Managing Python with conda](conda.md)). For now, we will introduce its basic functionality.
3232
:::
3333

34-
Then create a conda environment with Python installed by typing the following into your terminal:
34+
Then create a {term}`conda` environment with Python installed by typing the following into your terminal:
3535

3636
```
3737
$ conda create --name pythia_test_env python

0 commit comments

Comments
 (0)