Skip to content

Commit

Permalink
docs: add conda information for package (#1247)
Browse files Browse the repository at this point in the history
Co-authored-by: pyansys-ci-bot <pyansys.github.bot@ansys.com>
  • Loading branch information
RobPasMue and pyansys-ci-bot committed Jun 10, 2024
1 parent b2d3040 commit 7088984
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 4 deletions.
22 changes: 19 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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/
Expand All @@ -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
Expand Down Expand Up @@ -54,6 +64,12 @@ You can use `pip <https://pypi.org/project/pip/>`_ to install PyAnsys Geometry.
pip install ansys-geometry-core
You can also install PyAnsys Geometry from `Conda-Forge <https://anaconda.org/conda-forge/ansys-geometry-core>`_:

.. code:: bash
conda install -c conda-forge ansys-geometry-core
To install the latest development version, run these commands:

.. code:: bash
Expand Down
1 change: 1 addition & 0 deletions doc/changelog.d/1247.miscellaneous.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: add conda information for package
20 changes: 19 additions & 1 deletion doc/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/ansys/pyansys-geometry>`_ on GitHub.

.. contents::
Expand Down Expand Up @@ -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
------

Expand Down Expand Up @@ -116,3 +133,4 @@ For more information on PyAnsys Geometry usage, see :ref:`User guide <ref_user_g

.. LINKS AND REFERENCES
.. _pip: https://pypi.org/project/pip/
.. _conda: https://conda.io/projects/conda/en/latest/user-guide/getting-started.html
1 change: 1 addition & 0 deletions doc/styles/config/vocabularies/ANSYS/accept.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
(?i)ansys
(?i)api
(?i)check
[Cc]onda
(?i)dependabot
Direct API
Dockerfile
Expand Down

0 comments on commit 7088984

Please sign in to comment.