From 7088984b7468d11b4838b02a45f71717f0cf53b0 Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Mon, 10 Jun 2024 05:14:30 +0000 Subject: [PATCH] docs: add conda information for package (#1247) Co-authored-by: pyansys-ci-bot --- README.rst | 22 ++++++++++++++++--- doc/changelog.d/1247.miscellaneous.md | 1 + doc/source/getting_started/installation.rst | 20 ++++++++++++++++- .../config/vocabularies/ANSYS/accept.txt | 1 + 4 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 doc/changelog.d/1247.miscellaneous.md diff --git a/README.rst b/README.rst index 594cf51b31..17b17f6f63 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,8 @@ PyAnsys Geometry ================ -|pyansys| |python| |pypi| |downloads| |GH-CI| |codecov| |MIT| |black| |pre-commit| +|pyansys| |python| |MIT| |black| +|codecov| |GH-CI| |pre-commit| +|pypi| |pypi-downloads| |conda| |conda-downloads| .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC :target: https://docs.pyansys.com/ @@ -10,14 +12,22 @@ PyAnsys Geometry :target: https://pypi.org/project/ansys-geometry-core/ :alt: Python -.. |pypi| image:: https://img.shields.io/pypi/v/ansys-geometry-core.svg?logo=python&logoColor=white +.. |pypi| image:: https://img.shields.io/pypi/v/ansys-geometry-core.svg?logo=python&logoColor=white&label=PyPI :target: https://pypi.org/project/ansys-geometry-core :alt: PyPI -.. |downloads| image:: https://img.shields.io/pypi/dm/ansys-geometry-core.svg +.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/ansys-geometry-core?label=Conda&logo=anaconda&logoColor=white + :target: https://anaconda.org/conda-forge/ansys-geometry-core + :alt: Conda + +.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/ansys-geometry-core.svg?label=PyPI%20downloads :target: https://pypi.org/project/ansys-geometry-core/ :alt: PyPI Downloads +.. |conda-downloads| image:: https://img.shields.io/conda/dn/conda-forge/ansys-geometry-core?label=Conda%20downloads + :target: https://anaconda.org/conda-forge/ansys-geometry-core + :alt: Conda Downloads + .. |codecov| image:: https://codecov.io/gh/ansys/pyansys-geometry/graph/badge.svg?token=UZIC7XT5WE :target: https://codecov.io/gh/ansys/pyansys-geometry :alt: Codecov @@ -54,6 +64,12 @@ You can use `pip `_ to install PyAnsys Geometry. pip install ansys-geometry-core +You can also install PyAnsys Geometry from `Conda-Forge `_: + +.. code:: bash + + conda install -c conda-forge ansys-geometry-core + To install the latest development version, run these commands: .. code:: bash diff --git a/doc/changelog.d/1247.miscellaneous.md b/doc/changelog.d/1247.miscellaneous.md new file mode 100644 index 0000000000..be3273894d --- /dev/null +++ b/doc/changelog.d/1247.miscellaneous.md @@ -0,0 +1 @@ +docs: add conda information for package \ No newline at end of file diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index a7b9fd6d58..71c241854a 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -4,7 +4,7 @@ Install package in development mode ################################### This topic assumes that you want to install PyAnsys Geometry in developer mode so that -you can modify the source and enhance it. You can install PyAnsys Geometry from PyPI +you can modify the source and enhance it. You can install PyAnsys Geometry from PyPI, Conda, or from the `PyAnsys Geometry repository `_ on GitHub. .. contents:: @@ -43,6 +43,23 @@ Then, to install PyAnsys Geometry, run this command: python -m pip install ansys-geometry-core + +Conda +----- + +You can also install PyAnsys Geometry using `conda`_. First, ensure that you have the latest version: + +.. code:: bash + + conda update -n base -c defaults conda + +Then, to install PyAnsys Geometry, run this command: + +.. code:: bash + + conda install -c conda-forge ansys-geometry-core + + GitHub ------ @@ -116,3 +133,4 @@ For more information on PyAnsys Geometry usage, see :ref:`User guide