junos
/
rapids
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update example.rst

pull/95/head
JulioV 2020-08-14 17:59:05 -04:00 committed by GitHub
parent cbe7cc478d
commit 52e1955a0e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/usage/example.rst
View File

@ -7,14 +7,26 @@ This is a quick guide for creating and running a simple pipeline to analysis an
#. Install RAPIDS. See :ref:`Installation Section <install-page>`.
#. Make sure your database connection credentials in ``.env`` have write permission and set the correct ``MY_GROUP`` parameter in ``config.yaml`` file. See step 1 of :ref:`Usage Section <db-configuration>`.
#. Configure your database credentials (see example below or step 1 of :ref:`Usage Section <db-configuration>` for more information).
#. Make sure your Conda (python) environment is active. See step 6 of :ref:`install-page`.
#. Create an ``.env`` file at the root of RAPIDS folder
#. Your MySQL user must have write permissions because we will restore our example database
#. Name your credentials group ``MY_GROUP``.
#. If you are trying to connect to a local MySQL server from our docker container set your host according to this link_.
#. You can name your database anyway you want, for example ``rapids_example``
[MY_GROUP]
user=rapids
password=rapids
host=127.0.0.1 # or use host.docker.internal from our docker container
port=3306
database=rapids_example
#. Make sure your Conda (python) environment is active (the environment is already active in our docker container). See step 6 of :ref:`install-page`.
#. Run the following command to restore database from ``rapids_example.sql`` file::
sankemake -j1 restore_sql_file
snakemake -j1 restore_sql_file
#. Create example participants files with the following command::
@ -30,3 +42,4 @@ This is a quick guide for creating and running a simple pipeline to analysis an
snakemake -j8 --profile example_profile
.. _link: https://stackoverflow.com/questions/24319662/from-inside-of-a-docker-container-how-do-i-connect-to-the-localhost-of-the-mach