Skip to content

Commit

Permalink
version bump to include requests, confirmed working in venv
Browse files Browse the repository at this point in the history
  • Loading branch information
gidden committed Nov 19, 2018
1 parent 2ba0083 commit 78a7c01
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 45 deletions.
46 changes: 8 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://sphinx-doc.org/>`_ 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 (`<user>/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 .
```
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 4 additions & 5 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

0 comments on commit 78a7c01

Please sign in to comment.