Skip to content

Commit 9e5e439

Browse files
committed
📄 Documentation: add pypi install instructions
1 parent 8dfcf66 commit 9e5e439

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,11 @@ It has been developped at SafranTech, the research center of [Safran group](http
4141

4242
### 2.1 Using the library
4343

44-
To use the library, the simplest way is to install the conda package:
44+
To use the library, the simplest way is to install the conda-forge or PyPi package:
4545

4646
```bash
4747
conda install -c conda-forge plaid
48+
pip install pyplaid
4849
```
4950

5051
### 2.2 Contributing to the library
@@ -81,6 +82,11 @@ bash run_examples.sh # [unix]
8182
run_examples.bat # [win]
8283
```
8384

85+
**Note**
86+
87+
[pytest](https://anaconda.org/conda-forge/pytest) and [Muscat](https://anaconda.org/conda-forge/muscat) are two dependencies not included in the packages ``plaid`` on conda-forge or ``pyplaid`` on PyPi, but required to run the tests and examples. [pytest](https://pypi.org/project/pytest) is available on PyPi, mais not [Muscat](https://pypi.org/project/pytest).
88+
89+
8490
## 3. Call for Contributions
8591

8692
The PLAID project welcomes your expertise and enthusiasm!

docs/source/getting_started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ Everything you need to know to start using the PLAID.
1616

1717
### 1.1 Using the library
1818

19-
To use the library, the simplest way is to install the conda package:
19+
To use the library, the simplest way is to install the conda-forge or PyPi package:
2020

2121
```bash
2222
conda install -c conda-forge plaid
23+
pip install pyplaid
2324
```
2425

2526
### 1.2 Contributing to the library
@@ -56,7 +57,6 @@ bash run_examples.sh # [unix]
5657
run_examples.bat # [win]
5758
```
5859

59-
---
6060
**Note**
6161

62-
[pytest](https://anaconda.org/conda-forge/pytest) and [Muscat](https://anaconda.org/conda-forge/muscat) are two dependencies not distributed in the plaid conda-forge package, but can be found on conda-forge as well.
62+
[pytest](https://anaconda.org/conda-forge/pytest) and [Muscat](https://anaconda.org/conda-forge/muscat) are two dependencies not included in the packages ``plaid`` on conda-forge or ``pyplaid`` on PyPi, but required to run the tests and examples. [pytest](https://pypi.org/project/pytest) is available on PyPi, mais not [Muscat](https://pypi.org/project/pytest).

0 commit comments

Comments
 (0)