diff --git a/README.md b/README.md index 9d2a52e..cd9724b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ 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) @@ -8,14 +8,14 @@ So hacking here means we want to quickly deconstruct data, understand what we've 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 @@ -27,7 +27,7 @@ Exercises: * GitHub Project * Notebook Viewer -Running/Setup: +#####Setup: * Required packages: * Brew @@ -43,3 +43,11 @@ Running/Setup:
      %> sudo pip uninstall data_hacking
   
+ +#### 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): +
alias ipython='ipython notebook --FileNotebookManager.notebook_dir=`pwd`'
+
+$ cd data_hacking/fun_with_syslog
+$ ipython (as aliased above)
+
\ No newline at end of file