Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
findmyway committed Feb 26, 2014
1 parent 3aa511f commit 250d6ee
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 35 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.pyc
39 changes: 39 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#pmtk3-python
This is an experimental directory containing translations of a few
pmtk3 demos from Matlab to python. Over time, we hope to port
more and more functionality.

##Guide
If you are new to using python for scientific computing, I strongly recommend
you to spend some time on
[scipy-lecture-notes](scipy-lectures.github.io).
This document will give you a quick introduction to central tools and
techniques on the scientific Python ecosystem.

##Requirements
To run demos, you should have installed either python2 or python3 as you like.
You also need to install the following packages
- numpy
- scipy
- matplotlib
- sklearn
- networkx
Here are some instructions on how to install:
- How to install Python https://wiki.python.org/moin/BeginnersGuide/Download
- How to install numpy, scipy, matplotlib http://www.scipy.org/install.html
- How to install sklearn http://scikit-learn.org/stable/install.html
- How to install networkx http://networkx.github.io/documentation/latest/install.html

You may also need to install some other packages. Just follow the instructions above.

##How to run demos
All you need to do is setting the PYTHONPATH
- On linux, just put this in your ~/.bashrc
`export PYTHONPATH=/path/to/pmtk3/python` (without quotes)
- On windows, you need to open
My Computer > Properties > Advanced System Settings > Environment Variables >
![img1](http://i.stack.imgur.com/ZGp36.png)
Then under system variables create a new Variable called PYTHONPATH.
Fill the variable value with `/path/to/pmtk3/python` (without quotes)

In the future, maybe we can build a package to make things easier.
35 changes: 0 additions & 35 deletions python/README.txt

This file was deleted.

0 comments on commit 250d6ee

Please sign in to comment.