From c255b1d1d6968bbd6c36a1ca24b7fbdca9784534 Mon Sep 17 00:00:00 2001 From: Pablo de Andres <9430234+pablo-de-andres@users.noreply.github.com> Date: Mon, 24 Jan 2022 08:37:20 +0100 Subject: [PATCH 1/3] Bump ipython from 7.22.0 to 7.31.1 (#195) (#196) Bumps [ipython](https://github.com/ipython/ipython) from 7.22.0 to 7.31.1. - [Release notes](https://github.com/ipython/ipython/releases) - [Commits](https://github.com/ipython/ipython/compare/7.22.0...7.31.1) --- updated-dependencies: - dependency-name: ipython dependency-type: direct:production ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 7528b30..a8f844b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,7 +5,7 @@ sphinx_rtd_theme==0.5.2 sphinxcontrib-plantuml==0.20.1 nbsphinx==0.8.2 sphinx-copybutton==0.3.1 -ipython==7.22.0 +ipython==7.31.1 jupyter==1.0.0 sphinx-autobuild==2021.3.14 sphinx-panels==0.5.2 From 2f2ca9b486b863c772c7b8d7ca3b1b4a74cf172e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Manuel=20Dom=C3=ADnguez?= <43052541+kysrpex@users.noreply.github.com> Date: Thu, 10 Feb 2022 13:44:27 +0100 Subject: [PATCH 2/3] Publish OSP-core in PyPI (3.x branch) (#197) * Change documentation for PyPI release. * Update compatibility table. --- docs/source/installation.md | 81 ++++++++++++++++++++++--------------- docs/source/links.md | 7 ++-- 2 files changed, 53 insertions(+), 35 deletions(-) diff --git a/docs/source/installation.md b/docs/source/installation.md index 9305138..bf7c663 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,9 @@ 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 +39,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 +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 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 ff09e50cab6e996e9a291b3f4f1da467c7d6ce2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Manuel=20Dom=C3=ADnguez?= <43052541+kysrpex@users.noreply.github.com> Date: Thu, 10 Feb 2022 13:56:49 +0100 Subject: [PATCH 3/3] Update compatibility table for release 2.4.5 (#198) --- docs/source/links.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/links.md b/docs/source/links.md index 93fa131..d1cfbd4 100644 --- a/docs/source/links.md +++ b/docs/source/links.md @@ -57,7 +57,7 @@ The following table describes the compatibilities between of SimPhoNy docs and O ============= ========== SimPhoNy docs OSP-core ============= ========== - 2.4.5 3.6.2 + 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