install info

Author: alexrd

README.org

@@ -8,17 +8,31 @@ and graph visualization programs (e.g. Gephi).
 
 CSNAnalysis is currently in beta.
 
+* Installation
+To install CSNAnalysis, clone one of the releases and manually install it.
+
+#+BEGIN_SRC bash
+  git clone https://gitlab.com/ADicksonLab/CSNAnalysis
+  cd CSNAnalysis
+
+  # install
+  pip install --user -e .
+#+END_SRC
+
 * Dependencies
 - numpy
 - scipy
 - networkx
 
 * Features
 CSNAnalysis will have the following capabilities:
+
 - constructing transition probability matrices
 - trimming CSNs using a variety of criteria
 - computing committor probabilities with an arbitrary number of basins
 - computing hub-scores (mediation probabilities) with an arbitrary number of basins
+- export CSV files for node and edge files in Gephi format
+- compute undirected edge weights appropriate for graph visualization in Gephi
 
 * Misc
 ** Versioning

setup.py

@@ -0,0 +1,16 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='CSNAnalysis',
+    version='0.1.0-beta',
+    py_modules=['csnanalysis'],
+    author='Alex Dickson',
+    author_email='[email protected]',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        'Numpy',
+        'NetworkX',
+        'Scipy',
+    ],
+)