From f211295e70df1cea9c8a7c2ad5ad01ba98faced2 Mon Sep 17 00:00:00 2001 From: Daniel Huppmann Date: Wed, 19 Jan 2022 18:11:30 +0100 Subject: [PATCH] Update the installation instructions (#145) --- openentrance/README.md | 39 ++++++++++++++++++--------------------- setup.cfg | 6 +++--- 2 files changed, 21 insertions(+), 24 deletions(-) diff --git a/openentrance/README.md b/openentrance/README.md index f97b09d9..dc1ccc7b 100644 --- a/openentrance/README.md +++ b/openentrance/README.md @@ -10,7 +10,7 @@ Coming soon - for now, please have a look at [__init__.py](__init__.py)! ## Installation instructions -### Option 1: Clone the repo and install from source (recommended) +### Clone the repo and install from source This approach requires git to be installed on your machine. @@ -18,47 +18,44 @@ Clone this repository to your machine by opening a command prompt and directing it to the folder where you want to have the files, then run: ``` -$ git clone git@github.com:openENTRANCE/nomenclature.git +$ git clone git@github.com:openENTRANCE/openentrance.git ``` Then navigate the command prompt to the new folder and install using pip. ``` -$ cd nomenclature +$ cd openentrance +$ pip install -r requirements.txt $ pip install --editable . ``` > Pulling new commits in the cloned folder will immediately > make the latest version of the nomenclature available on your machine. -You can test whether the installation worked successfully by running +You can test whether the installation worked successfully by install **pytest** using ``` -$ pytest openentrance/tests/ +$ pip install pytest ``` -The result should look similar to the following snippet: +and then running ``` -============================= test session starts ============================== -platform darwin -- Python 3.7.7, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 -rootdir: ... -collected 4 items - -openentrance/tests/test_core.py .... [100%] - -============================== 4 passed in 30.00s ============================== +$ pytest openentrance/tests/ ``` -If you see a few warnings, this is (probably) also ok... +The result should look similar to the following snippet: -### Option 2: Install directly from GitHub +``` +============================= test session starts ============================== +platform darwin -- Python 3.9.7, pytest-5.4.3, py-1.10.0, pluggy-0.13.1 +collected 20 items -Open a command prompt and run +tests/test_core.py .. [ 10%] +tests/test_definitions.py ...... [ 40%] +tests/test_validate.py ............ [100%] -``` -pip install git+https://github.com/openENTRANCE/nomenclature +============================= 20 passed in 40.83s ============================== ``` -> :warning: You will have to repeat this step whenever you want -> to update the `openentrance` package on your machine. +If you see a few warnings, this is (probably) also ok... diff --git a/setup.cfg b/setup.cfg index 49c6bafa..805da16f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,17 +3,17 @@ name = openentrance author = openENTRANCE consortium author_email = huppmann@iiasa.ac.at license = APACHE-2.0 -description = Nomenclature for the openENTRANCE project: variables, units, regions, ... +description = Nomenclature and utility methods for the Horizon 2020 openENTRANCE project long_description = file: README.md long_description_content_type = text/x-md -url = https://github.com/openENTRANCE/nomenclature +url = https://github.com/openENTRANCE/openentrance [options] packages = openentrance install_requires = setuptools >= 41 pyyaml - nomenclature + nomenclature-iamc pyam-iamc >= 1.0 # the pyam package is released on pypi under this name iam-units >= 2021.11.12 setup_requires =