Skip to content

Commit

Permalink
Fine tuning documentation changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
cnobles committed Dec 16, 2024
1 parent d491a76 commit 4c8a25a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
# -- Project information -----------------------------------------------------

project = 'iGUIDE'
copyright = '2024, Christopher Nobles, Ph.D.'
copyright = '2024, Christopher Nobles, Ph.D'
author = 'Christopher Nobles, Ph.D.'

# The short X.Y version
Expand Down
28 changes: 14 additions & 14 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -443,18 +443,18 @@ Manual Install
Skip to installing iGUIDE if you already have miniconda or anaconda installed.
These can be executed in your home directory.

Get the latest version of miniconda install script.::
Get the latest version of miniconda install script::

__conda_url=https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
wget -q ${__conda_url} -O miniconda.sh

Installing miniconda through downloaded script. You can choose a different path
for the install, here it is installed into the home directory.::
for the install, here it is installed into the home directory::

__conda_path="~/miniconda3"
bash miniconda.sh -b -p ${__conda_path}

Source conda to activate the installation for use.::
Source conda to activate the installation for use::
source ${__conda_path}/etc/profile.d/conda.sh

Expand All @@ -464,20 +464,20 @@ The following commands should be called from within the iGUIDE directory

Install the conda environment from the requirements file. The name field here
can be changed to what you would like to call the environment, default for the
install script is 'iguide'.::
install script is 'iguide'::

conda create --name=iguide --quiet --yes --file etc/build.b1.0.1.txt

After successful creation of the environment, activate the iguide environment (or what
you've named it).::
you've named it)::

conda activate iguide

Install the supporting R-package into the environment.::
Install the supporting R-package into the environment::

R CMD INSTALL tools/iguideSupport

Setup your environmental variables.::
Setup your environmental variables::

__iguide_dir=$(pwd)

Expand All @@ -490,38 +490,38 @@ Setup your environmental variables.::
${CONDA_PREFIX}/etc/conda/deactivate.d/env_vars.sh

You should now deactivate and reactivate the environment to initiate the environmental
variables.::
variables::

conda deactivate
conda activate iguide

Lastely, install the command line interface for iGUIDE using pip.::
Lastely, install the command line interface for iGUIDE using `pip`::
pip install --upgrade tools/iguidelib/

**Testing**
Test to make sure the components were installed correctly.

Test for required R-packages installed.::
Test for required R-packages installed::

$(Rscript tools/rscripts/check_for_required_packages.R &> /dev/null) && echo true || echo false

Check to make sure iguideSupport was installed correctly.::
Check to make sure iguideSupport was installed correctly::

$(Rscript tools/rscripts/check_pkgs.R iguideSupport &> /dev/null) && echo true || echo false

Run unit tests for iguideSupport.::
Run unit tests for iguideSupport::

`$(Rscript tools/rscripts/check_iguideSupport.R &> /dev/null) && echo true || echo false'

Check to make sure the pip install of the CLI was successful.::
Check to make sure the pip install of the CLI was successful::

command -v iguide &> /dev/null && echo true || echo false

Run tests for iGUIDE, this step will take a little bit to complete if it starts processing
the test case. Go grab a coffee, you deserve it getting to this point. :) The test will
activate the environment as part of the test, so you should deactivate your environment
first and then initiate the test.::
first and then initiate the test::

conda deactivate
bash etc/tests/test.sh iguide
Expand Down

0 comments on commit 4c8a25a

Please sign in to comment.