From c638644eb5db8330a9cc896b68ac65558b7da026 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Manuel=20Dom=C3=ADnguez?= Date: Fri, 4 Feb 2022 15:33:54 +0100 Subject: [PATCH 1/3] Change documentation for PyPI release. --- docs/source/installation.md | 82 ++++++++++++++++++++++--------------- 1 file changed, 50 insertions(+), 32 deletions(-) diff --git a/docs/source/installation.md b/docs/source/installation.md index 9305138..1bdd6a9 100644 --- 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,10 @@ or a [conda](https://docs.conda.io/en/latest/) environment: ~/test$ conda activate ``` -## 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 +40,8 @@ python -m osp.core.pico install ``` ## 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/.git @@ -76,7 +61,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 +75,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 +``` From 3a97c38f5f6f96ee7e44ec93f3eb3f0c927553be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Manuel=20Dom=C3=ADnguez?= Date: Fri, 4 Feb 2022 15:38:54 +0100 Subject: [PATCH 2/3] Update versions. --- docs/source/links.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/links.md b/docs/source/links.md index 71a6ea4..93fa131 100644 --- 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.6.2 + 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 From cf95a7e361d6486f3af8184da618db6d4d36a7a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Manuel=20Dom=C3=ADnguez?= Date: Fri, 4 Feb 2022 16:40:40 +0100 Subject: [PATCH 3/3] Fix newline. --- docs/source/installation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/installation.md b/docs/source/installation.md index 1bdd6a9..bf7c663 100644 --- a/docs/source/installation.md +++ b/docs/source/installation.md @@ -25,8 +25,7 @@ or a [conda](https://docs.conda.io/en/latest/) environment. 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`. +`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)