readme and docs

abhishek1591 · Jan 12, 2017 · 6aa57b1 · 6aa57b1
1 parent 26f71c0
commit 6aa57b1
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 33 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,7 +4,7 @@ Change Log
 [1.1.1] - 2017-01-12
 ----------------------
 - [ADDED] installation description and pypi files from github
-- [ADDED] automatic inversion of active power limits in convert format (see change below)
+- [ADDED] automatic inversion of active power limits in convert format to account for convention change in version 1.1.0
 - [CHANGED] install_requires in setup.py
 
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,3 @@
-include LICENSE AUTHORS README.rst requirements.txt CHANGELOG.rst installation.rst
+include LICENSE AUTHORS README.rst requirements.txt CHANGELOG.rst
 global-include *.p 
 
diff --git a/README.rst b/README.rst
@@ -1,4 +1,30 @@
-include installation.rst
+pandapower combines the data analysis library `pandas <http://pandas.pydata.org>`_ and the power flow solver `PYPOWER <https://pypi.python.org/pypi/PYPOWER>`_ to create an easy to use network calculation program
+aimed at automation of analysis and optimization in power systems.
+
+pandapower is a joint development of the research group Energy Management and Power System Operation, University of Kassel and the Department for Distribution System
+Operation at the Fraunhofer Institute for Wind Energy and Energy System Technology (IWES), Kassel.
+
+For more information, go to `<http://www.uni-kassel.de/go/pandapower>`_.
+
+Installation
+==============
+To install pandapower, simply use: ::
+
+    pip install pandapower
+
+This will install the following dependencies:
+    - pypower>=5.0.1
+    - pandas
+    - networkx
+
+To use all of pandapowers functionalites, you will need the following additional packages:
+    - numba>=0.25.0 (for accelerated loadflow calculation)
+    - matplotlib (for plotting)
+    - python-igraph (for plotting networks without geographical information)
+    - xlrd (for loading/saving files from/to excel)
+    - openpyxl (for loading/saving files from/to excel)
+
+We recommend the `Anaconda Distribution <https://www.continuum.io/downloads>`_, which already contains a lot of modules for scientific computing that are needed for working with pandapower.
 
 Minimal Example
 =====================

diff --git a/doc/getting_started/installation.rst b/doc/getting_started/installation.rst
@@ -20,9 +20,9 @@ pandapower itself can be installed with the following steps:
 
 1. Download and unzip the `pandapower source distribution <http://www.uni-kassel.de/eecs/fachgebiete/e2n/software/pandapower.html>`_ to your local hard drive.
 
-2. Open a command prompt (e.g. Windows --> cmd) and navigate to the folder that contains the setup.py file with the command cd <folder> ::
+2. Open a command prompt (e.g. Windows cmd or Anaconda Command Prompt) and navigate to the folder that contains the setup.py file with the command cd <folder> ::
 
-    cd %path_to_pandapower%\pandapower-1.0.2\
+    cd %path_to_pandapower%\pandapower-x.x.x\
 
 3. Install pandapower by running ::
 
@@ -47,7 +47,7 @@ pandapower itself can be installed with the following steps:
         - openpyxl (for loading/saving files from/to excel)
 
 .. note::
-    All of these packages except pypower are included in the anacaonda distribution. 
+    All of these packages except pypower and python-igraph are already included in the anacaonda distribution. 
 
 If you are having problems with the dependencies, you can also install these packages manually with pip install or any 
 other way you like.

diff --git a/installation.rst b/installation.rst
diff --git a/setup.py b/setup.py
@@ -7,14 +7,20 @@
 
 from setuptools import setup, find_packages
 
+with open('README.rst', 'rb') as f:
+    install = f.read().decode('utf-8').partition("Minimal Example")[0]
+with open('CHANGELOG.rst', 'rb') as f:
+    changelog = f.read().decode('utf-8')
+
+long_description = '\n\n'.join((install, changelog))
+
 setup(
     name='pandapower',
     version='1.1.1',
     author='Leon Thurner, Alexander Scheidler',
     author_email='[email protected], [email protected]',
     description='Convenient Power System Modelling and Analysis based on PYPOWER and pandas',
-    long_description = '\n\n'.join(open(f, 'rb').read().decode('utf-8')
-                               for f in ['installation.rst', 'CHANGELOG.rst']),
+    long_description = long_description,
     url='http://www.uni-kassel.de/go/pandapower',
     license='BSD',
     install_requires=["pypower>=5.0.1",