Skip to content

docs: installation steps #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 21, 2024
Merged

docs: installation steps #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cdeb5f
docs: installation steps
RobPasMue Feb 21, 2024
47a0a32
Update doc/source/getting_started/index.rst
RobPasMue Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/source/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Installing PyHPS in developer mode allows you to modify and enhance the source:

.. code:: bash

git clone https://github.com/pyansys/pyhps
git clone https://github.com/ansys-internal/pyhps

#. Access the directory where you have cloned the repository:

Expand Down Expand Up @@ -111,6 +111,7 @@ This way, it's not possible for you to push code that fails the style checks::
isort....................................................................Passed
flake8...................................................................Passed
codespell................................................................Passed
Add License Headers......................................................Passed

Documentation
-------------
Expand Down
9 changes: 4 additions & 5 deletions doc/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,13 @@ You must have pip_ and Python 3.9, 3.10, 3.11, or 3.12 installed.
Installation
------------

Because PyHPS is a private PyAnsys package not yet published to PyPI, install it by
running this command:
To install PyHPS in user mode, run this command:

.. code::
.. code:: bash

python -m pip install git+https://github.com/ansys-internal/pyhps
python -m pip install ansys-hps-client

``pip`` automatically installs any of these package dependencies that are not already installed:
``pip`` automatically installs these package dependencies in case they are not already installed:

- requests_
- marshmallow_
Expand Down