Skip to content

Update README to include instructions #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cs-hall wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README to include instructions #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 43 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,48 @@ it should make you happy.

Prepare to SMILE...

Installing SMILE
================

First you need Kivy, which is the primary dependency of SMILE
Sometimes kivy has conflicts with some other packages, so we create a new virtual environment for working with SMILE:

::

conda create -n smile
conda activate smile

Now we can install kivy:

::

conda install -c conda-forge kivy


If you plan on running SMILE from within Jupyter Notebook (only suggested for development and not data collection), you'll need to install that, too:

::

conda install notebook


Then you can install SMILE right from the GitHub repository:

::

pip install --upgrade git+https://github.com/compmem/smile


All together...

::

conda create -n smile
conda activate smile
conda install -c conda-forge kivy
pip install --upgrade git+https://github.com/compmem/smile



Dependencies
============
Expand Down Expand Up @@ -44,3 +86,4 @@ Documentation
=============

For detailed documentation, please visit http://smile-docs.readthedocs.io/