Installation Documentation

[joey-kilgore]

It doesn't appear that there is any set instructions for installation of superneuroabm attached to this repository. While other repos do explain the general process, it should be included directly in this repository, as well as instructions for those who want to develop directly with superneuroabm.

The current best practice for a clean python experience is to use virtual environments. This allows users to install particular packages and not worry about collisions or messing up their system python package registry. This utilizes virtualenv in the following way on ubuntu, and windows users can utilize the visual studio code GUI to create virtual environments as well. Below are the instructions for ubuntu, that can be done in any project or directory (you don't need to clone this repo to use it)

1. virtualenv venv - which creates a virtual environment
2. source venv/bin/activate - activating the virtual environment
3. pip install superneuroabm - pip install this repo since it is available on pip

The process for developers is relatively similar except they will need to clone this repo, and install the package directly from the source (in editable mode) with the following (again for ubuntu)

1. clone superneuroabm
2. cd superneuroabm
3. virtualenv venv
4. source venv/bin/activate
5. pip install -e . - this install the package in editable mode, so any edits to the source code in the repo will automatically be updated python imports upon running any script referencing this package run with the virtual environment we just setup

Additionally there should be some steps or guidance for the cuda installation, even if it's just a link to NVIDIA's docs

I'm sure others might have additional ideas/suggestions to this general workflow, but I do think there needs to be some kind of installation description in this repository itself, especially since this is the repo that pip's registry points to.