Skip to content

Commit ffb24c9

Browse files
committed
Revised package installation instructions
1 parent f7e2341 commit ffb24c9

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

README_Template.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# [[FileReaderName]]
2-
[[One line description]]
2+
[[One-line description]]
33

44
## Description
55
[[Full description]]
@@ -11,15 +11,16 @@
1111
[[Usage example]]
1212

1313
## Installation
14-
- OVITO PRO built-in Python interpreter
15-
```
16-
ovitos -m pip install --user git+[[Repository Link]].git
17-
```
18-
- Standalone Python package or Conda environment
19-
```
20-
pip install --user git+[[Repository Link]].git
21-
```
22-
- Please note that the `--user` tag is recommended but optional and depends on your Python installation.
14+
- OVITO Pro [integrated Python interpreter](https://docs.ovito.org/python/introduction/installation.html#ovito-pro-integrated-interpreter):
15+
```
16+
ovitos -m pip install --user git+[[Repository Link]].git
17+
```
18+
The `--user` option is recommended and [installs the package in the user's site directory](https://pip.pypa.io/en/stable/user_guide/#user-installs).
19+
20+
- Other Python interpreters or Conda environments:
21+
```
22+
pip install git+[[Repository Link]].git
23+
```
2324

2425
## Technical information / dependencies
2526
- Tested on OVITO version [[VersionNumber]]

pyproject.toml

+2-4
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,9 @@ authors = [{name = "[[Author 1 name]]", email = "[[Author 1 email]]"}, {name = "
1111
maintainers = [{name = "[[Maintainer 1 name]]", email = "[[Maintainer 1 email]]"}, {name = "[[Maintainer 2 name]]", email = "[[Maintainer 2 email]]"}]
1212
license = {text = "[[License]]"}
1313
readme = "README.md"
14-
requires-python = "[[>=3.7]]"
14+
requires-python = ">=3.7"
1515
dependencies = [
16-
"ovito >= [[VersionNumber]]", # OVITO must be >=3.9!
17-
# "[[dependency1]]",
18-
# "[[dependency2 == Version]]",
16+
"ovito >= 3.9.1",
1917
]
2018

2119
[project.urls]

0 commit comments

Comments
 (0)