Skip to content

Commit

Permalink
updating readme to talk about how to run ipython
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Wylie committed Jan 12, 2014
1 parent f3f6793 commit c10dbf0
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
data_hacking
============
Welcome to the Click Security Data Hacking Project
### Welcome to the Click Security Data Hacking Project

"Hacking in the sense of deconstructing an idea, hardware, anything and getting it to do something it wasn’t intended or to better understand how something works."(BSides CFP)

So hacking here means we want to quickly deconstruct data, understand what we've got and how to best utilize it for the problem at hand.

The primary motivation for these exercises is to explore the nexus of iPython, Pandas and Scikit Learn on security data of various kinds. The exercises will often intentionally show common missteps, warts in the data, paths that didn't work out that well and results that could definitely be improved upon. In general we're trying to capture what worked and what didn't, not only is that more realistic but often much more informative to the reader. :)

Python Modules Used:
##### Python Modules Used:

* iPython: Architecture for interactive computing and presentation (http://ipython.org)
* Pandas: Python Data Analysis Library (http://pandas.pydata.org)
* Scikit Learn (http://scikit-learn.org) Scikit-learn: Machine Learning in Python, Pedregosa et al., JMLR 12, pp. 2825-2830, 2011.
* Matplotlib: Python 2D plotting library (http://matplotlib.org)

Exercises:
##### Exercises:

* Detecting Algorithmically Generated Domains
* GitHub Project
Expand All @@ -27,7 +27,7 @@ Exercises:
* GitHub Project
* Notebook Viewer

Running/Setup:
#####Setup:

* Required packages:
* Brew
Expand All @@ -43,3 +43,11 @@ Running/Setup:
<pre>
%> sudo pip uninstall data_hacking
</pre>

#### Running the Notebooks:
Most of the notebooks will have relative paths to some resources, data files or images. In general the easiest way we found to run ipython on the notebooks is to change into that project directory and run ipython with this alias (put in your .bashrc or whatever):
<pre>alias ipython='ipython notebook --FileNotebookManager.notebook_dir=`pwd`'</pre>
<pre>
$ cd data_hacking/fun_with_syslog
$ ipython (as aliased above)
</pre>

0 comments on commit c10dbf0

Please sign in to comment.