Skip to content

Commit 1e99a07

Browse files
Update the installation directions (#90)
* Update Getting_Started.rst * Update doc/source/Resources/Getting_Started.rst * Update doc/source/Resources/Getting_Started.rst * Update Getting_Started.rst * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: Roberto Pastor Muela <[email protected]>
1 parent 1796213 commit 1e99a07

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

doc/source/Resources/Getting_Started.rst

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,47 @@ Getting started
44
Installation
55
~~~~~~~~~~~~
66

7-
This package is not yet available on PyPI, so for now the only real
8-
option is for you to download the code from GitHub:
7+
This package is not yet available on the public PyPI, but you can still install
8+
it using ``pip`` from our private PyPI repository.
9+
10+
The following on Windows:
11+
12+
.. code::
13+
14+
set PYANSYS_PYPI_PRIVATE_PAT=<REDACTED>
15+
set INDEX_URL=https://%PYANSYS_PYPI_PRIVATE_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
16+
python -m pip install ansys-dyna-core --index-url %INDEX_URL%
17+
18+
And if you are running Linux:
19+
20+
.. code::
21+
22+
PYANSYS_PYPI_PRIVATE_PAT=<REDACTED>
23+
export INDEX_URL='https://[email protected]/pyansys/_packaging/pyansys/pypi/simple/'
24+
python -m pip install ansys-dyna-core --index-url $INDEX_URL
25+
26+
Email your friendly PyAnsys team member for the ``PYANSYS_PYPI_PRIVATE_PAT``
27+
at `[email protected] <mailto:[email protected]>`_ or send us a message via Teams.
28+
29+
**Installing from git**
30+
31+
If you have ``git`` installed and want the bleeding edge version:
32+
33+
.. code::
34+
35+
pip install -U git+https://github.com/pyansys/pyDyna@main
36+
37+
You need to be logged into GitHub locally and be a member of the `PyAnsys Organization <https://github.com/pyansys>`_.
38+
39+
Alternatively, if you need to modify the repository locally (or want to
40+
do local development), you can clone it and install it in "development" mode with:
941

1042
.. code::
1143
1244
git clone https://github.com/pyansys/pyDyna
45+
cd pyDyna
46+
pip install -e .
1347
14-
and copy the required files.
48+
Note the ``-e`` flag, which denotes that you are in development mode.
49+
You can make changes in the local ``pyDyna`` and have them reflected
50+
in your local install of PyDyna.

0 commit comments

Comments
 (0)