From ee6e41d6c837aa528ac2e840e8dccb01d2202aad Mon Sep 17 00:00:00 2001 From: alexvoss Date: Wed, 8 Apr 2026 10:08:20 -0400 Subject: [PATCH 1/3] add conda-forge install Signed-off-by: alexvoss --- docs/get-started.md | 57 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/docs/get-started.md b/docs/get-started.md index a8380a2..6edd1ab 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -125,3 +125,60 @@ use `uv run` or activate the project's virtual environment manually. [uvtool]: https://docs.astral.sh/uv/concepts/tools/#tool-environments +!!! tip "Other tools using PyPI" + There are, of course, other dependency managers and build tools in the + Python ecosystem that use PyPI as the repository. Installing Zensical with + them should be similar to the process of installing with `uv`. Refer to + their documentation for details. + +## Third-party distributions + +There are other distributions that make Zensical available but they may or may +not use the official packages we distribute exclusively through PyPI. You can +use these distributions if you have good reasons to do so but for normal use we +recommend the installation methods above that we officially support. + + +### Install with Anaconda/Mamba { data-toc-label="Anaconda/Mamba" } + +Zensical is available in the [conda-forge] community repository so that it can +be installed using [Anaconda] or [Mamba]. + + [conda-forge]: https://conda-forge.org/ + [Anaconda]: https://www.anaconda.com + [Mamba]: https://mamba.readthedocs.io + +!!! warning + We cannot provide support for distributions we do not control. If you + experience any issues please contact the maintainers of the packages within + these distributions. + +=== ":material-apple: macOS" + ```sh + conda create -n zensical python=3.14.* + conda activate zensical + conda install -c conda-forge zensical + ``` + +=== ":fontawesome-brands-windows: Windows" + + If you are using Anaconda or Mamaba, make sure that the base environment is + activated. If you are using Anaconda, you can just open an [Anaconda + Prompt]. If you installed Mamba as part of [Miniforge], there will be an + equivalent Miniforge Prompt. + + ```ps1 + conda create -n zensical python=3.14.* + conda activate zensical + conda install -c conda-forge zensical + ``` + +=== ":material-linux: Linux" + ```sh + conda create -n zensical python=3.14.* + conda activate zensical + conda install -c conda-forge zensical + ``` + +[Anaconda Prompt]: https://www.anaconda.com/docs/reference/glossary#anaconda-prompt +[Miniforge]: https://conda-forge.org/download/ From c50c92c2856644780f5224842e008c495205b8a4 Mon Sep 17 00:00:00 2001 From: alexvoss Date: Wed, 8 Apr 2026 16:29:53 -0400 Subject: [PATCH 2/3] remove superfluous asterisks Signed-off-by: alexvoss --- docs/get-started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/get-started.md b/docs/get-started.md index 6edd1ab..cebe239 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -155,7 +155,7 @@ be installed using [Anaconda] or [Mamba]. === ":material-apple: macOS" ```sh - conda create -n zensical python=3.14.* + conda create -n zensical python=3.14 conda activate zensical conda install -c conda-forge zensical ``` @@ -168,14 +168,14 @@ be installed using [Anaconda] or [Mamba]. equivalent Miniforge Prompt. ```ps1 - conda create -n zensical python=3.14.* + conda create -n zensical python=3.14 conda activate zensical conda install -c conda-forge zensical ``` === ":material-linux: Linux" ```sh - conda create -n zensical python=3.14.* + conda create -n zensical python=3.14 conda activate zensical conda install -c conda-forge zensical ``` From 73883eaee161060472c87e329d6933d49e4f866e Mon Sep 17 00:00:00 2001 From: alexvoss Date: Wed, 8 Apr 2026 20:03:07 -0400 Subject: [PATCH 3/3] add link to zensical-feedstock, remove syntax highlighting Signed-off-by: alexvoss --- docs/get-started.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/get-started.md b/docs/get-started.md index cebe239..a9ee3b9 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -150,11 +150,13 @@ be installed using [Anaconda] or [Mamba]. !!! warning We cannot provide support for distributions we do not control. If you - experience any issues please contact the maintainers of the packages within - these distributions. + experience any issues please contact the maintainers of + [conda-forge/zensical-feedstock]. + + [conda-forge/zensical-feedstock]: https://github.com/conda-forge/zensical-feedstock === ":material-apple: macOS" - ```sh + ``` conda create -n zensical python=3.14 conda activate zensical conda install -c conda-forge zensical @@ -167,14 +169,14 @@ be installed using [Anaconda] or [Mamba]. Prompt]. If you installed Mamba as part of [Miniforge], there will be an equivalent Miniforge Prompt. - ```ps1 + ``` conda create -n zensical python=3.14 conda activate zensical conda install -c conda-forge zensical ``` === ":material-linux: Linux" - ```sh + ``` conda create -n zensical python=3.14 conda activate zensical conda install -c conda-forge zensical