Merge pull request #199 from simphony/dev

Merge release 2.4.5.
simphony · Feb 10, 2022 · 8e4d914 · 8e4d914
2 parents f0e49f8 + ff09e50
commit 8e4d914
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 35 deletions.
diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -1,7 +1,14 @@
 # Installation
-For the installation and usage of the framework Python 3.6 or higher is needed.
-We *highly* encourage the use of a [virtual environment](https://docs.python.org/3/tutorial/venv.html)
-or a [conda](https://docs.conda.io/en/latest/) environment:
+
+For the installation and usage of the framework Python 3.6 or higher is 
+needed. OSP-core is available on PyPI, so it can be installed using `pip`:
+
+```shell
+~/test$ pip install osp-core
+```
+
+However, we *highly* encourage the use of a [virtual environment](https://docs.python.org/3/tutorial/venv.html)
+or a [conda](https://docs.conda.io/en/latest/) environment.
 
 ```shell
 # virtual environment 
@@ -16,33 +23,9 @@ or a [conda](https://docs.conda.io/en/latest/) environment:
 ~/test$ conda activate <env name>
 ```
 
-## OSP-core installation
-First, the repository must be cloned:
-
-```shell
-git clone https://github.com/simphony/osp-core.git
-cd osp-core
-```
-
-The installation is based on setuptools:
-
-```sh
-# build and install (recommended)
-pip install .
-
-# alternative
-python3 setup.py install
-```
-
-or:
-
-```sh
-# build for in-place development (recommended)
-pip install -e .
-
-# alternative
-python3 setup.py develop
-```
+Unfortunately, OSP-core is not available on the Anaconda Repository, so 
+in both cases, after setting up the environment, it must be installed with 
+`pip install osp-core`.
 
 After installing OSP-core, you can install your ontology namespaces.
 We provide the tool [`pico`](./utils.md#pico-installs-cuds-ontologies)
@@ -56,7 +39,8 @@ python -m osp.core.pico install <path/to/ontology.yml>
 ```
 
 ## Wrapper installation
-The installation of a wrapper is similar. First, the repository is cloned:
+Wrappers are currently not available on PyPI, so they must be installed 
+from source. First, the repository is cloned:
 
 ```shell
 git clone https://github.com/simphony/<some-wrapper>.git
@@ -76,7 +60,7 @@ It will automatically call `install_engine_requirements.sh`, where the engine sp
 ./install_engine.sh
 ```
 
-Now the wrapper can be installed:
+Now, the wrapper can be installed:
 
 ```shell
 python3 setup.py install
@@ -90,3 +74,36 @@ Simply run the `docker_install.sh` script. There is no need to install OSP-core
 ```shell
 ./docker_install.sh
 ```
+
+
+## Installing OSP-core from source
+
+If you are a developer or an advanced user, you might be interested in 
+installing OSP-core from source.
+
+To do so, first the repository must be cloned:
+
+```shell
+git clone https://github.com/simphony/osp-core.git
+cd osp-core
+```
+
+The installation is based on setuptools:
+
+```sh
+# build and install (recommended)
+pip install .
+
+# alternative
+python3 setup.py install
+```
+
+or:
+
+```sh
+# build for in-place development (recommended)
+pip install -e .
+
+# alternative
+python3 setup.py develop
+```
diff --git a/docs/source/links.md b/docs/source/links.md
@@ -57,9 +57,10 @@ The following table describes the compatibilities between of SimPhoNy docs and O
    =============  ==========
    SimPhoNy docs  OSP-core  
    =============  ==========
-   2.4.4          3.5.8   
-   2.4.3          3.5.5
-   2.4.2          3.5.4
+   2.4.5          3.7.0   
+   2.4.4          3.5.8-beta
+   2.4.3          3.5.5-beta
+   2.4.2          3.5.4-beta
    2.4.1          3.5.3.1-beta
    2.4.0          3.5.2-beta
    2.3.x          3.4.0-beta