From 78a7c019fba4fdcb4c51f246968fd402f9553315 Mon Sep 17 00:00:00 2001 From: Matthew Gidden Date: Mon, 19 Nov 2018 15:50:26 +0100 Subject: [PATCH] version bump to include requests, confirmed working in venv --- README.md | 46 ++++++++---------------------------------- doc/source/conf.py | 4 ++-- doc/source/install.rst | 9 ++++----- 3 files changed, 14 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 4e472ceec..350ef0ad9 100644 --- a/README.md +++ b/README.md @@ -61,44 +61,14 @@ The ``pyam`` package is licensed under the Apache License, Version 2.0 (the "License"); see [LICENSE](LICENSE) and [NOTICE](NOTICE.md) for details. -Python dependencies -------------------- - -0. `pandas` v0.21.0 or higher -0. `matplotlib` -0. `seaborn` -0. `geopandas` (optional) -0. `cartopy` (optional) - -Documentation Building Depedencies ----------------------------------- - -0. `Sphinx `_ v1.1.2 or higher -0. `sphinxcontrib.bibtex` -0. `sphinxcontrib-fulltoc` -0. `sphinx-gallery` - -Installation instructions -------------------------- - -0. Fork this repository and clone the forked repository (`/pyam`) - to your machine. To fork the repository, look for the fork icon in the top - right at [iiasa/pyam](https://github.com/iiasa/pyam). - Add `iiasa/pyam` as `upstream` to your clone. - - *We recommend* [GitKraken](https://www.gitkraken.com/) *for users* - *who prefer a graphical user interface application* - *to work with Github (as opposed to the command line).* - -### Windows Users - -0. Double click on `install.bat` in the local folder where you cloned your fork. - -### *nix Users +Install +------- -0. In a command prompt, execute the following command +For basic instructions see our +[website](http://software.ene.iiasa.ac.at/pyam/install.html). - ``` - python setup.py install - ``` +To install from source after cloning this repository, simply run +``` +pip install -e . +``` diff --git a/doc/source/conf.py b/doc/source/conf.py index e2aab5376..bab06bd28 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -76,9 +76,9 @@ # built documents. # # The short X.Y version. -version = '0.1.1' +version = '0.1.2' # The full version, including alpha/beta/rc tags. -release = '0.1.1' +release = '0.1.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/source/install.rst b/doc/source/install.rst index c9a92f476..33eadc9c9 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -22,20 +22,19 @@ From Source .. code-block:: bash - git clone https://github.com/IAMconsortium/pyam && cd pyam - pip install -r requirements.txt && python setup.py install + pip install -e git+https://github.com/IAMconsortium/pyam.git#egg=pyam Depedencies ~~~~~~~~~~~ -The depedencies for :code:`pyam` are: +The optional depedencies for :code:`pyam` are: .. include:: ../../requirements.txt - :start-line: 1 + :start-line: 0 :literal: The depedencies for building this documentation are: .. include:: ../requirements.txt - :start-line: 1 + :start-line: 0 :literal: