Skip to content

Commit dfba42f

Browse files
lorenzncodenobkd
andauthored
docs: Update install docs to Miniforge (#1682)
* docs: Update install docs to Miniforge * Update wire fillet docstring to remove extraneous param (see PR 1630) * Update fillet method docstring * Update cadquery/occ_impl/shapes.py Co-authored-by: nobkd <[email protected]> * Update Miniforge link in README --------- Co-authored-by: nobkd <[email protected]>
1 parent 5720c7d commit dfba42f

File tree

3 files changed

+26
-13
lines changed

3 files changed

+26
-13
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ There are also videos covering installation:
6161

6262
### CadQuery Installation Via Conda
6363

64-
To first install the Conda package manager see [Install the Conda Package Manager](https://cadquery.readthedocs.io/en/latest/installation.html#install-the-conda-package-manager), and [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge) for a minimal installer.
64+
To first install the Conda package manager see [Install the Conda Package Manager](https://cadquery.readthedocs.io/en/latest/installation.html#install-the-conda-package-manager), and [Miniforge](https://github.com/conda-forge/miniforge) for a minimal installer.
6565

6666
``mamba install`` is recommended over ``conda install`` for faster and less memory intensive cadquery installation.
6767

cadquery/occ_impl/shapes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2558,9 +2558,9 @@ def fillet(
25582558
"""
25592559
Apply 2D or 3D fillet to a wire
25602560
2561-
:param wire: The input wire to fillet. Currently only open wires are supported
25622561
:param radius: the radius of the fillet, must be > zero
2563-
:param vertices: Optional list of vertices to fillet. By default all vertices are fillet.
2562+
:param vertices: the vertices to delete (where the fillet will be applied). By default
2563+
all vertices are deleted except ends of open wires.
25642564
:return: A wire with filleted corners
25652565
"""
25662566

doc/installation.rst

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,32 +18,45 @@ Begin by installing the conda package manager. If conda is already installed sk
1818
Install the Conda Package Manager
1919
``````````````````````````````````
2020

21-
In principle, any Conda distribution will work, but it is probably best to install `Mambaforge <https://github.com/conda-forge/miniforge#mambaforge>`_ to a local directory and to avoid running `conda init`. After performing a local directory installation, Mambaforge can be activated via the [scripts,bin]/activate scripts. This will help avoid polluting and breaking the local Python installation.
21+
In principle, any Conda distribution will work, but it is probably best to install `Miniforge <https://github.com/conda-forge/miniforge>`_ to a local directory and to avoid running `conda init`. After performing a local directory installation, Miniforge can be activated via the [scripts,bin]/activate scripts. This will help avoid polluting and breaking the local Python installation.
2222

23-
Mambaforge is a minimal installer that sets *conda-forge* as the default channel for package installation and provides `mamba <https://mamba.readthedocs.io/en/latest/user_guide/mamba.html>`_. You can swap almost all commands between conda & mamba.
23+
Miniforge is a minimal installer that sets *conda-forge* as the default channel for package installation and provides `mamba <https://mamba.readthedocs.io/en/latest/user_guide/mamba.html>`_. You can swap almost all commands between conda & mamba.
2424

2525
In Linux/MacOS, the local directory installation method looks something like this:
2626

2727
.. code-block::
2828
29-
# Install to ~/mambaforge
30-
curl -L -o mambaforge.sh "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
31-
bash mambaforge.sh -b -p $HOME/mambaforge
29+
# Install to ~/miniforge
30+
curl -L -o miniforge.sh "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
31+
bash miniforge.sh -b -p $HOME/miniforge
3232
3333
# Activate
34-
source $HOME/mambaforge/bin/activate
34+
source $HOME/miniforge/bin/activate
3535
3636
3737
On Windows, download the installer and double click it on the file browser or install non-interactively as follows:
3838

3939
.. code-block::
40+
:caption: Windows CMD
4041
41-
:: Install to %USERPROFILE%\Mambaforge
42-
curl -L -o mambaforge.exe https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-Windows-x86_64.exe
43-
start /wait "" mambaforge.exe /InstallationType=JustMe /RegisterPython=0 /NoRegistry=1 /NoScripts=1 /S /D=%USERPROFILE%\Mambaforge
42+
:: Install to %USERPROFILE%\Miniforge
43+
curl -L -o miniforge.exe https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe
44+
start "" /wait miniforge.exe /InstallationType=JustMe /RegisterPython=0 /NoRegistry=1 /NoScripts=1 /S /D=%USERPROFILE%\Miniforge
4445
4546
:: Activate
46-
cmd /K ""%USERPROFILE%/Mambaforge/Scripts/activate.bat" "%USERPROFILE%/Mambaforge""
47+
cmd /K ""%USERPROFILE%/Miniforge/Scripts/activate.bat" "%USERPROFILE%/Miniforge""
48+
49+
50+
.. code-block::
51+
:caption: PowerShell
52+
53+
# Install to $env:USERPROFILE\Miniforge
54+
curl.exe -L -o miniforge.exe https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe
55+
Start-Process -Wait -FilePath miniforge.exe -ArgumentList @("/InstallationType=JustMe", "/RegisterPython=0", "/NoRegistry=1", "/NoScripts=1", "/S", "/D=$env:USERPROFILE\Miniforge")
56+
57+
# Activate
58+
. $env:USERPROFILE\Miniforge\shell\condabin\conda-hook.ps1
59+
conda activate
4760
4861
It might be worthwhile to consider using ``/NoScripts=0`` to have an activation shortcut added to the start menu.
4962

0 commit comments

Comments
 (0)