Added release, updated installation method

spinjet · Feb 14, 2024 · 54177e9 · 54177e9
1 parent 401be2f
commit 54177e9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -28,15 +28,21 @@ The optional visualisation tool requires the `dash-plotly` package to be install
 
 ## Installation
 
-First `git clone` the repository or download the zip file.
-Then run the setup from the root folder:
+The reccomended method is through pyPI by running the command:
+
+```
+pip install pdopt
+```
+
+Alternatevly it is possible to donwload the release, or `git clone` the repository. Then run the setup from the root folder:
 
 ```
 pip install -e .
 ```
 
 Use the `--user` option if not running in admin mode.
 
+
 ## Documentation
 
 Online API documentation with example usage can be found [here](https://pdopt-code.readthedocs.io/en/latest/).

diff --git a/docs/index.md b/docs/index.md
@@ -14,8 +14,13 @@ This online user guide provides a description of the usage, an example analysis,
 
 ## Installation
 
-First `git clone` the repository or download the zip file.
-Then run the setup from the root folder:
+The reccomended method is through pyPI by running the command:
+
+```
+pip install pdopt
+```
+
+Alternatevly it is possible to donwload the release, or `git clone` the repository. Then run the setup from the root folder:
 
 ```
 pip install -e .