Metadata-Version: 1.1
Name: helixmc
Version: 0.5
Summary: Python-based Monte Carlo simulator for DNA/RNA duplexes.
Home-page: http://fcchou.github.com/HelixMC/
Author: Fang-Chieh Chou
Author-email: fcchou1986@gmail.com
License: GPL
Download-URL: https://github.com/fcchou/HelixMC/tarball/master
Description: .. image:: https://travis-ci.org/fcchou/HelixMC.png?branch=master
              :target: https://travis-ci.org/fcchou/HelixMC/
        
        ######
        README
        ######
        
        HelixMC
        =======
        HelixMC is a software package for Monte-Carlo (MC) simulations of DNA/RNA
        helices using the base-pair level model, coded with Python. HelixMC is
        distributed under the GPLv3 licence.
        
        The project is authored by Fang-Chieh Chou in 2013, under the supervison of
        Dr. Rhiju Das, at the Biochemistry Department of Stanford Unviersity.
        
        Links
        =====
        - Source code: https://github.com/fcchou/HelixMC
        - HTML documentation: http://helixmc.readthedocs.org/
        - Das Lab @ Stanford: http://daslab.stanford.edu
        
        Dependencies
        ============
        The required dependencies to build the software are Python >= 2.7,
        Numpy >= 1.6, SciPy >= 0.10, Matplotlib >= 1.1.0,
        and a working C/C++ compiler.
        
        Install
        =======
        This package uses distutils, which is the default way of installing
        python modules. To install, simply use::
        
          python setup.py build
          sudo python setup.py install
        
        Alternatively, you can add your HelixMC folder into the system's ``$PATH`` and
        ``$PYTHONPATH``. In bash this can be done by adding the following lines to your
        ``~/.bashrc``::
        
            export PATH=$PATH:<HelixMC Path>
            export PYTHONPATH=$PYTHONPATH:<HelixMC Path>
        
        Then build the Cython extension. Under the ``helixmc/`` folder, run::
        
            python _cython_build.py build_ext --inplace
        
        Note that this requires you to have Cython installed. Otherwise you can choose
        to build the c source file, then you do not need Cython::
        
            python _c_build.py build_ext --inplace
        
Platform: Linux
Platform: Mac OS-X
Platform: Unix
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
