Commit 0ea87d09 authored by Matthieu Boileau's avatar Matthieu Boileau
Browse files

Update README and add environment.yml

parent 8c438bdf
......@@ -2,4 +2,7 @@
.vscode/
.ipynb_checkpoints/
__pycache__/
custom.el
\ No newline at end of file
custom.el
optimal_transport.html
percolation.html
simple_random_walk.html
......@@ -4,44 +4,30 @@
## Installation
### Install pip
### Using Conda
Follow the [instructions](https://pip.pypa.io/en/stable/installing/).
#### Install Anaconda
### install `virtualenv`
Follow instructions for installing [Anaconda](https://www.anaconda.com/distribution/#download-section) for python 3.
```bash
pip install --user virtualenv
```
### Install dependencies
Create virtual environment:
```bash
virtualenv .env
```
#### Install dependencies
Activate virtualenv:
From project root directory, run:
```bash
source .env/bin/activate
conda env create -f environment.yml
```
Install dependencies:
```bash
pip install -r requirements.txt
```
> **Note:** the `Solving environment` step may be long, be patient...
## Usage
### Activate virtualenv
### Activate environment
From project root directory, run:
Before first execution, run:
```bash
source .env/bin/activate
conda activate mc2020
```
### Run within Jupyter notebooks
......@@ -54,6 +40,8 @@ jupyter-notebook
### Launch python scripts from command line
From project root directory, run:
```bash
python srw.py
```
......
name: mc2020
channels:
- conda
- conda-forge
dependencies:
- cython
- ffmpeg
- ipywidgets
- jupyter
- matplotlib
- numba
- numpy
- POT
- progressbar2
- seaborn
- scikit-learn
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment