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

Updated instructions to clarify database (.env) file setup.

pull/95/head
nleo575 2020-03-06 17:24:52 -05:00
parent 4dcf65d575
commit a2d1ef2818
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/usage/installation.rst
View File

@ -112,16 +112,24 @@ Once you have the installation for your specific operating system complete, you
#. Configure the database connection:
- Create an empty file called `.env` in the root directory (rapids/)
- Create an empty file called `.env` in the root directory (``rapids/``)
- Add and complete the following lines:
.. code-block:: bash
[MY_GROUP_NAME]
user=MyUSER
password=MyPassword
host=MyIP
port=3306
| ``[MY_GROUP_NAME]``
| ``user=MyUSER``
| ``password=MyPassword``
| ``host=MyIP``
| ``port=3306``
- Replace your database specific credentials with those listed above.
- ``MY_GROUP_NAME`` is a custom label you assign when setting up the database configuration. It does not have to relate to your
.. _the-install-note:
.. note::
- ``MY_GROUP_NAME`` must also be assigned to the ``DATABASE_GROUP`` variable in the ``config.yaml`` file, which is located in the root directory (``rapids/config.yaml``).
- Ensure that your list of ``SENSORS`` in the ``config.yaml`` file correspond to the sensors used in the ``all`` rule in the ``Snakefile`` file (See :ref:`rapids-structure` for more information)
#. Once the all of the installation and configurations has been completed the following command can be run to pull the default sample dataset that comes with this project.::
@ -130,13 +138,6 @@ Once you have the installation for your specific operating system complete, you
This pulls sample data from AWARE_ and processes it with the default rules that come with RAPIDS.
.. _the-install-note:
.. note::
- Ensure that ``MY_GROUP_NAME`` is the same value for GROUP in the ``DATABASE_GROUP`` variable in the ``config.yaml`` file located in the root directory (rapids/config.yaml).
- Ensure that your list of ``SENSORS`` in the ``config.yaml`` file correspond to the sensors used in the ``all`` rule in the ``Snakefile`` file (See :ref:`rapids-structure` for more information)
.. _bug: https://github.com/Homebrew/linuxbrew-core/issues/17812