Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Link to ReadTheDocs, mention license and tidy.
  • Loading branch information
khaeru committed Apr 23, 2014
1 parent b6b8aa3 commit 20f5d76
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# py-gdx
# PyGDX

py-gdx is a Python 3 package for accessing data stored in GDX-formatted files, through the Python bindings for the [GAMS](http://www.gams.com) [GDX API](http://www.gams.com/dd/docs/api/expert-level/gdxqdrep.html).
PyGDX is a Python 3 package for accessing data stored in GDX-formatted files, through the Python bindings for the [GAMS](http://www.gams.com) [GDX API](http://www.gams.com/dd/docs/api/expert-level/gdxqdrep.html). Inspired by the similar package, also named [py-gdx, by Geoff
Leyland](https://github.com/geoffleyland/py-gdx), this version makes use of [pandas](http://pandas.pydata.org/) to provide labelled data structures which can be easily manipulated with [NumPy](http://www.numpy.org/) for calculations and plotting.

Originally inspired by the similar package, also called py-gdx, by Geoff
Leyland (https://github.com/geoffleyland/py-gdx), this version makes use of [pandas](http://pandas.pydata.org/) to provide Pythonic data structures for access to GAMS data, which can be easily intergrated into [NumPy](http://www.numpy.org/)-based code.
**Documentation** is available at http://pygdx.readthedocs.org/, built automatically from the contents of the Github repository.

Documentation is available at http://khaeru.github.io/py-gdx/
PyGDX is provided under the **MIT License** (see `LICENSE`).

Example
-------
Expand All @@ -14,7 +14,7 @@ With the following GAMS program:
````
set s 'Animals' /
a Aardvark
b 'Blue whale'
b Blue whale
c Chicken
d Dingo
e Elephant
Expand Down Expand Up @@ -49,7 +49,7 @@ The parameter `p` can be accessed via:
````python
>>> import gdx
>>> f = gdx.File('example.gdx')
>>> f.p[:,'y',CA']
>>> f.p[:,'y','CA']
a 1
b 1
c 1
Expand All @@ -58,4 +58,4 @@ e 1
f 1
g 1
dtype: float64
````
````

0 comments on commit 20f5d76

Please sign in to comment.