Skip to content

Commit

Permalink
Readme update (#39)
Browse files Browse the repository at this point in the history
* Update README.md
  • Loading branch information
oldfly authored and takabayashi committed Dec 4, 2017
1 parent af87a39 commit 01ada84
Showing 1 changed file with 39 additions and 39 deletions.
78 changes: 39 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,55 +23,55 @@ Take the following steps to install Marvin Toolbox:
1. Libsasl2-dev, Python-pip and Graphviz installation
```
Ubuntu:
$ sudo apt-get install libsasl2-dev python-pip graphviz -y
sudo apt-get install libsasl2-dev python-pip graphviz -y
MacOS:
$ sudo easy_install pip
$ brew install openssl graphviz
sudo easy_install pip
brew install openssl graphviz
```
2. VirtualEnvWrapper Installation
```
$ sudo pip install --upgrade pip
$ sudo pip install virtualenvwrapper
sudo pip install --upgrade pip
sudo pip install virtualenvwrapper
```
3. Spark installation
```
$ curl https://d3kbcqa49mib13.cloudfront.net/spark-2.1.1-bin-hadoop2.6.tgz -o /tmp/spark-2.1.1-bin-hadoop2.6.tgz
$ sudo tar -xf /tmp/spark-2.1.1-bin-hadoop2.6.tgz -C /opt/
$ sudo ln -s /opt/spark-2.1.1-bin-hadoop2.6 /opt/spark
sudo tar -xf /tmp/spark-2.1.1-bin-hadoop2.6.tgz -C /opt/
sudo ln -s /opt/spark-2.1.1-bin-hadoop2.6 /opt/spark
$ echo "export SPARK_HOME=/opt/spark" >> $HOME/.bash_profile
echo "export SPARK_HOME=/opt/spark" >> $HOME/.bash_profile
```
4. Set environment variables
```
$ echo "export WORKON_HOME=$HOME/.virtualenvs" >> $HOME/.bash_profile
$ echo "export MARVIN_HOME=$HOME/marvin" >> $HOME/.bash_profile
$ echo "export MARVIN_DATA_PATH=$HOME/marvin/data" >> $HOME/.bash_profile
$ echo "source virtualenvwrapper.sh" >> $HOME/.bash_profile
echo "export WORKON_HOME=$HOME/.virtualenvs" >> $HOME/.bash_profile
echo "export MARVIN_HOME=$HOME/marvin" >> $HOME/.bash_profile
echo "export MARVIN_DATA_PATH=$HOME/marvin/data" >> $HOME/.bash_profile
echo "source virtualenvwrapper.sh" >> $HOME/.bash_profile
$ source ~/.bash_profile
source ~/.bash_profile
````
5. Clone and install python-toolbox
```
$ mkdir $MARVIN_HOME
$ mkdir $MARVIN_DATA_PATH
$ cd $MARVIN_HOME
mkdir $MARVIN_HOME
mkdir $MARVIN_DATA_PATH
cd $MARVIN_HOME

$ git clone https://github.com/marvin-ai/marvin-python-toolbox.git
$ cd marvin-python-toolbox
git clone https://github.com/marvin-ai/marvin-python-toolbox.git
cd marvin-python-toolbox

$ mkvirtualenv python-toolbox-env
$ setvirtualenvproject
mkvirtualenv python-toolbox-env
setvirtualenvproject

$ make marvin
make marvin
````
6. Test the installation
```
$ marvin test
marvin test
```
### Installing Marvin with Others SOs
Take the following steps to install Marvin Toolbox using Vagrant:
Expand All @@ -82,21 +82,21 @@ Take the following steps to install Marvin Toolbox using Vagrant:
2. Clone repository and start provision
```
$ git clone https://github.com/marvin-ai/marvin-vagrant-dev.git
$ cd marvin-vagrant-dev
git clone https://github.com/marvin-ai/marvin-vagrant-dev.git
cd marvin-vagrant-dev
```
3. Prepare dev (engine creation) box
```
$ vagrant up dev
$ vagrant ssh dev
vagrant up dev
vagrant ssh dev
```
Wait for provision process and follow interactive configuration script after access the dev box using vagrant ssh command.
4. The marvin source projects will be on your home folder, to compile and use the marvin toolbox
```
$ workon python-toolbox-env
$ make marvin
workon python-toolbox-env
make marvin
```
### Creating a new engine
1. To create a new engine
Expand All @@ -108,25 +108,25 @@ Respond the interactive prompt and wait for the engine environment preparation,
2. Test the new engine
```
$ workon <new_engine_name>-env
$ marvin test
workon <new_engine_name>-env
marvin test
```
3. For more informations
```
$ marvin --help
marvin --help
```
### Working in an existing engine
1. Set VirtualEnv and get to engine's path
```
$ workon <engine_name>-env
workon <engine_name>-env
```
2. Test your engine
```
$ marvin test
marvin test
```
3. Bring up the notebook and access it from your browser
```
$ marvin notebook
marvin notebook
```
### Command line interface
Usage: marvin [OPTIONS] COMMAND [ARGS]
Expand Down Expand Up @@ -163,17 +163,17 @@ Commands:
### Running a example engine
1. Clone example engine from repository
```
$ git clone https://github.com/marvin-ai/engines.git
git clone https://github.com/marvin-ai/engines.git
```
2. Generate a new marvin engine environment for Iris species engine
```
$ workon python-toolbox-env
$ marvin engine-generateenv ../engines/iris-species-engine/
workon python-toolbox-env
marvin engine-generateenv ../engines/iris-species-engine/
```
3. Run the Iris species engine
```
$ workon iris-species-engine-env
$ marvin engine-dryrun
workon iris-species-engine-env
marvin engine-dryrun
```
> Marvin is a project started at B2W Digital offices and released open source on September 2017.

0 comments on commit 01ada84

Please sign in to comment.