From 8239eb437ba19b92f133652edc76702df20157f7 Mon Sep 17 00:00:00 2001 From: yupenghe Date: Wed, 6 Dec 2017 17:41:01 -0800 Subject: [PATCH] update README --- docs/README.rst | 29 +++++++++++++++++++++-------- setup.py | 2 +- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/docs/README.rst b/docs/README.rst index a140258..292d206 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -85,14 +85,15 @@ install methylpy and run If you would like to install methylpy in path of your choice, run ``python setup.py install --prefix=/USER/PATH/``. Then, try ``methylpy`` -and if it gives no error, the setup is likely successful. See `Test +and if no error pops out, the setup is likely successful. See `Test methylpy <#test-methylpy>`__ for more rigorious test. Last, processing -large dataset will require space for storing temporary files. However, -the default directory is unlikely to fit the need. You may want to set -the ``TMPDIR`` environmental variable to the absolute path of a -directory on hard drive with sufficient space (e.g. ``/YOUR/TMP/DIR/``). -This can be done by adding the below command to ~/.bashrc file: -``export TMPDIR=/YOUR/TMP/DIR/``. +large dataset will require large spare space for temporary files. +Usually, the default directory for temporary files will not meet the +need. You may want to set the ``TMPDIR`` environmental variable to the +(absolute) path of a directory on hard drive with sufficient space (e.g. +``/YOUR/TMP/DIR/``). This can be done by adding the below command to +``~/.bashrc file``: ``export TMPDIR=/YOUR/TMP/DIR/`` and run +``source ~/.bashrc``. Step 2 - Install dependencies ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -158,9 +159,21 @@ correctly, run :: - cd methylpy/test + wget http://neomorph.salk.edu/yupeng/share/methylpy_test.tar.gz + tar -xf methylpy_test.tar.gz + cd methylpy_test/ python run_test.py +The test should take around 3 minutes, and progress will be printed on +screen. After the test is started, two files ``test_output_msg.txt`` and +``test_error_msg.txt`` will be generated. The former contains more +details about each test and the later stores error message (if any) as +well as additional information. + +If test fails, please check ``test_error_msg.txt`` for the error +message. If you decide to submit an issue regarding test failure to +methylpy github page, please include the error message in this file. + Process data ============ diff --git a/setup.py b/setup.py index 5719dc8..871bd0a 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name='methylpy', - version='1.2.3', + version='1.2.4', author='Yupeng He', author_email='yupeng.he.bioinfo@gmail.com', packages=['methylpy'],