Skip to content

Commit 3db344f

Browse files
authored
#25 Fix example version in docs (#30)
1 parent c7f27a5 commit 3db344f

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

doc/source/api.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To obtain the metapackage version, use this code:
1111
>>> from pygranta import __version__
1212
>>> __version__
1313
14-
'2023.1.0'
14+
'2023.2.0'
1515
1616
The documentation for each PyGranta package has its own "API reference" section.
1717
You can click the following cards to access their specific API documentation.

doc/source/getting_started.rst

+22-16
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,14 @@ the easiest is simply to run this command:
1919
2020
pip install pygranta
2121
22-
This installs all the PyGranta packages for the latest released
23-
version of Granta MI (for example, 2023 R2).
22+
This installs all the PyGranta packages for the latest released version of Granta MI.
23+
24+
If you are interested in **installing a specific version**, such as ``2023.2.0``, you
25+
can run a command like this one:
26+
27+
.. code:: bash
28+
29+
pip install pygranta==2023.2.0
2430
2531
You can always install PyGranta packages individually by following the installation
2632
instructions for each package. For example, the instructions for PyGranta
@@ -47,12 +53,12 @@ Then, install the ``pygranta`` metapackage with this command:
4753
4854
python -m pip install pygranta
4955
50-
If you are interested in **installing a specific version**, such as ``2023.1.0``, you
56+
If you are interested in **installing a specific version**, such as ``2023.2.0``, you
5157
can run a command like this one:
5258

5359
.. code:: bash
5460
55-
python -m pip install pygranta==2023.1.0
61+
python -m pip install pygranta==2023.2.0
5662
5763
5864
Offline mode installation
@@ -65,19 +71,19 @@ architecture from the repository's `Releases
6571
<https://github.com/ansys/pygranta/releases>`_ page.
6672

6773
Each wheelhouse archive contains all the Python wheels necessary to install
68-
the ``pygranta`` metapackage from scratch on Windows and Linux from Python
69-
3.8 to 3.11. You can install this on an isolated system with a fresh Python
74+
the ``pygranta`` metapackage from scratch on Windows and Linux for all supported
75+
Python versions. You can install this on an isolated system with a fresh Python
7076
installation or on a virtual environment.
7177

72-
For example, on Linux with Python 3.9, unzip the wheelhouse archive and install
78+
For example, on Linux with Python 3.12, unzip the wheelhouse archive and install
7379
it with these commands:
7480

7581
.. code:: bash
7682
77-
unzip pygranta-v2023.1.dev0-wheelhouse-Linux-3.9-core.zip wheelhouse
83+
unzip pygranta-v2023.2.0-wheelhouse-Linux-3.12-core.zip wheelhouse
7884
pip install pygranta -f wheelhouse --no-index --upgrade --ignore-installed
7985
80-
If you're on Windows with Python 3.9, unzip to a wheelhouse directory and install
86+
If you're on Windows with Python 3.12, unzip to a wheelhouse directory and install
8187
using the same command as for Linux.
8288

8389
Consider installing using a `virtual environment <https://docs.python.org/3/library/venv.html>`_.
@@ -95,30 +101,30 @@ following versioning system is followed:
95101
96102
Where:
97103

98-
- ``XXXX`` is the Ansys product release year (for example, 2022).
104+
- ``XXXX`` is the Ansys product release year (for example, 2024).
99105
- ``Y`` is the Ansys product release within the same year (for example, 1,
100106
which relates to R1).
101107
- ``ZZ`` is the patched versions to the ``pygranta`` metapackage, if any.
102108

103-
Consequently, the first ``pygranta`` metapackage compatible with the 2024 R2
109+
Consequently, the first ``pygranta`` metapackage compatible with the 2024 R1
104110
release would be:
105111

106112
.. code:: bash
107113
108-
2024.2.0
114+
2024.1.0
109115
110116
Any subsequent patched version of this package would have these versions:
111117

112118
.. code:: bash
113119
114-
2024.2.1
115-
2024.2.2
116-
2024.2.3
120+
2024.1.1
121+
2024.1.2
122+
2024.1.3
117123
...
118124
119125
When using ``pip`` to install your package, you can install a specific version with a
120126
command like this:
121127

122128
.. code:: bash
123129
124-
python -m pip install pygranta==2024.2.0
130+
python -m pip install pygranta==2024.1.0

0 commit comments

Comments
 (0)