Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 44 additions & 9 deletions doc/documentation/usage/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,62 @@
Installation
============

Requirements
------------

Create an environment
WhoBPyT requires **Python 3.9 or higher**.

Quick Install (pip)
-------------------

The easiest way to install WhoBPyT is via pip:

.. code::

$ pip install whobpyt


Install from Source
-------------------

To install the latest development version directly from GitHub, first create and activate a conda environment:

.. code::

$ conda create -n "whobpyt" git pip python=3.9
$ conda activate whobpyt

Clone the repository and install:

.. code::

$ git clone https://github.com/GriffithsLab/whobpyt
$ cd whobpyt
$ pip install .

Clone latest version from github
For an editable (development) install that reflects local code changes immediately:

.. code::

$ git clone https://github.com/GriffithsLab/whobpyt


Now go to the cloned folder and install manually
$ pip install -e .


Optional: Development and Documentation Dependencies
-----------------------------------------------------

To install additional dependencies needed for running tests or building the documentation:

.. code::

  $ cd whobpyt
  $ pip install -r requirements.txt
  $ pip install -e .
$ pip install -r requirements.txt


Verifying the Installation
--------------------------

After installation, you can verify that WhoBPyT is correctly installed by running the following in a Python session:

.. code:: python

import whobpyt
print(whobpyt.__version__)
Loading