Skip to content

Commit 7b8c438

Browse files
Update documentation
1 parent 5b05bb3 commit 7b8c438

File tree

2 files changed

+25
-33
lines changed

2 files changed

+25
-33
lines changed

core/esmf-aspect-meta-model-python/scripts/download_samm_cli.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Download SAMM CLI.
22
3-
Windows: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.6.1/samm-cli-2.6.1-windows-x86_64.zip
4-
Linux: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.6.1/samm-cli-2.6.1-linux-x86_64.tar.gz
5-
JAR: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.6.1/samm-cli-2.6.1.jar
3+
Windows: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.10.2/samm-cli-2.10.2-windows-x86_64.zip
4+
Linux: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.10.2/samm-cli-2.10.2-linux-x86_64.tar.gz
5+
JAR: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.10.2/samm-cli-2.10.2.jar
66
"""
77

88
import os

documentation/python-sdk-guide/modules/ROOT/pages/index.adoc

Lines changed: 22 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,19 @@ python --version
3131
----
3232

3333
* In order to include the packages a Python dependency manager is required; we recommend
34-
https://python-poetry.org/[Python Poetry].
34+
either https://pypi.org/project/pip/[pip] or https://python-poetry.org/[Python Poetry].
3535
The remainder of the guide assumes usage of Poetry.
36-
Please refer to the https://python-poetry.org/docs/#installation[Poetry installation guide].
37-
You can check your installed Poetry version with
36+
Please refer to the https://pip.pypa.io/en/stable/installation/[pip installation] or
37+
https://python-poetry.org/docs/#installation[Poetry installation guide].
38+
You can check your installed pip/Poetry version with
3839
+
3940
[source,bash]
4041
----
42+
pip --version
43+
----
44+
or
45+
[source,bash]
46+
----
4147
poetry --version
4248
----
4349

@@ -59,52 +65,38 @@ If you want to work with Aspect Models in your Python solution you should instal
5965
=== PyPI
6066

6167
To install the esmf-aspect-model-loader from PyPI, you can use the following command:
62-
6368
[source,bash]
6469
----
65-
poetry add esmf-aspect-model-loader
70+
pip install esmf-aspect-model-loader
6671
----
6772

6873
You can specify the version of the package by adding the version number after the package name.
6974
For example, to install version 2.2.0 of the package, you can use the following command:
7075
[source,bash]
7176
----
72-
poetry add esmf-aspect-model-loader==2.2.0
77+
pip install esmf-aspect-model-loader==2.2.0
7378
----
7479

75-
For more detailed information how to add a library via poetry please read https://python-poetry.org/docs/cli/#add[Poetry add guide].
76-
77-
=== GitHub Releases
80+
For more detailed information how to install a library with pip please read
81+
https://pip.pypa.io/en/stable/user_guide/#installing-packages[pip Installing Packages guide].
7882

79-
To use GitHub release as dependency using Poetry, you need to add it like this:
83+
=== Poetry
8084

81-
[source,toml]
85+
To install the esmf-aspect-model-loader from PyPI with poetry dependency manager, you can use the following command:
86+
[source,bash]
8287
----
83-
[tool.poetry.dependencies]
84-
esmf-aspect-model-loader = { git = "https://github.com/eclipse-esmf/esmf-sdk-py-aspect-model-loader.git", tag = "v2.2.0", subdirectory = "core/esmf-aspect-meta-model-python" }`
88+
poetry add esmf-aspect-model-loader
8589
----
8690

87-
for more information on depend on a library located in a git:
88-
https://python-poetry.org/docs/dependency-specification/#git-dependencies[git dependencies]
89-
90-
91-
== Installation with local package
92-
93-
The Python package is an archive with the file ending `.tar.gz`.
94-
If you are working with Poetry, you can easily import that package by adding the local reference to your `pyproject.toml`
95-
96-
[source,toml]
91+
You can specify the version of the package by adding the version number after the package name.
92+
For example, to install version 2.2.0 of the package, you can use the following command:
93+
[source,bash]
9794
----
98-
[tool.poetry.dependencies]
99-
esmf-aspect-model-loader = { path = "path/to/esmf-aspect-meta-model-python-x.y.z.tar.gz" }
95+
poetry add esmf-aspect-model-loader==2.2.0
10096
----
10197

102-
To make Poetry recognize your changes, run
103-
[source,bash]
98+
For more detailed information how to add a library via poetry please read https://python-poetry.org/docs/cli/#add[Poetry add guide].
10499

105-
----
106-
poetry update
107-
----
108100

109101
=== Loading an Aspect Model
110102

0 commit comments

Comments
 (0)