Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yupenghe committed Dec 7, 2017
1 parent b3ebf6b commit 8239eb4
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 9 deletions.
29 changes: 21 additions & 8 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -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
============

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='methylpy',
version='1.2.3',
version='1.2.4',
author='Yupeng He',
author_email='[email protected]',
packages=['methylpy'],
Expand Down

0 comments on commit 8239eb4

Please sign in to comment.