Skip to content

Corrections and enhancements to README.markdown #674

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
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Corrections and enhancements to README.markdown #674

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ce5f6f9
Small spelling corrections in README.markdown
vovtz May 25, 2015
62f1d2b
README.markdown re-wordings/spelling corrections
vovtz May 25, 2015
27f0d08
Prevent Homebrew warning
vovtz May 25, 2015
d695142
More syntax/spelling and technical corrections
vovtz May 25, 2015
5e555c1
Small layout improvement
vovtz May 25, 2015
fa43671
Corrected pre-installed Python versions
vovtz May 27, 2015
e42f5da
Merge pull request #1 from vovtz/vovtz-patch-spelling
vovtz Jun 7, 2015
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
131 changes: 76 additions & 55 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Quick Links:
* [Virtual Environment](#virtualenv)
* [Arch Linux](#arch-linux)
* [Fedora](#fedora)
* [MacOS](#mac-os-x-106-and-above)
* [OS X](#os-x-106-and-above)
* [Windows](#windows-7vista)
* [Raspberry Pi](#raspberry-pi)
* [SimpleCV Shell](#simplecv-interactive-shell-or-how-to-run-simplecv)
Expand Down Expand Up @@ -55,18 +55,18 @@ For more code snippets, we recommend the [SimpleCV examples website](http://exam
<a id="installation"></a>
## Installation

The easiest way to install SimpleCV is with the packages for your distribution (Windows, Mac, Linux) included on the website (http://www.simplecv.org). Although it is tested on many platforms there maybe scenarios where it just won't work with the package installer. Below is instructions on how to install, if you have problems please see the troubleshooting section at the end of this README file.
The easiest way to install SimpleCV is with the packages for your distribution (Windows, OS X (Mac), Linux) included on the website (http://www.simplecv.org). Although it is tested on many platforms there may be scenarios where it just won't work with the package installer. Below are instructions on how to install, if you have problems please see the troubleshooting section at the end of this README file.

<a id="docker"></a>
### Docker
This is the recommended way of installing SimpleCV as you can be sure the environment will be setup the same exact way as it's suppose to be on your machine.
This is the recommended way of installing SimpleCV as you can be sure the environment will be setup the exact way it's supposed to be on your machine.

*WARNING*: Using docker does not allow the webcam to work, it also doesn't work with Image.show(), so essentially requires you to use simplecv within an IPython notebook.
*WARNING*: Using Docker does not allow the webcam to work, it also doesn't work with Image.show(), so essentially requires you to use SimpleCV within an IPython notebook.

The first step is to install docker on your machine if you have not, this should work for Windows, Mac, and Linux, please follow instructions at:
The first step is to install Docker on your machine. If you have not, this should work for Windows, OS X (Mac), and Linux, please follow instructions at:
<a href="https://docs.docker.com/installation/">https://docs.docker.com/installation/</a>

Once docker is installed you can run simplecv as easy as (may have to run as sudo, depending on OS):
Once Docker is installed you can run SimpleCV as easy as (may have to run as sudo, depending on OS):

docker pull sightmachine/simplecv

Expand All @@ -78,27 +78,27 @@ Then just open your web browser and go to:

http://localhost:54717

**NOTE**: If you are using a Mac or Windows it will be a little different since you will be boot2docker to run. When you run boot2docker up it should show the ip address of the docker service. It could be something like 192.168.59.103, but this will change as it's random. Once you know that ip you will just go to that IP address with the correct port instead:
**NOTE**: If you are using OS X (Mac) or Windows it will be a little different since you will be using boot2docker to run. When you run boot2docker it should show the IP address of the Docker service. It will be something like 192.168.59.103, but different on your machine as it's random. Once you know that IP you will just go to that IP address with the correct port instead:

http://192.168.59.103:54717

You will get a Ipython notebook inteface, start a new notebook and enter the following:
You will get a IPython notebook interface, start a new notebook and enter the following:

from SimpleCV import *
disp = Display(displaytype='notebook')
img = Image('simplecv')
img.save(disp)

You should now see the simplecv logo and now have a full simplecv environment setup to start playing around.
You should now see the SimpleCV logo and now have a full SimpleCV environment setup to start playing around.

<a id="ubuntu-1204"></a>
### Ubuntu 12.04
Install with pip
Install with pip:

sudo apt-get install ipython python-opencv python-scipy python-numpy python-pygame python-setuptools python-pip
sudo pip install https://github.com/sightmachine/SimpleCV/zipball/develop

Install using clone of SimpleCV repository
Install using a clone of the SimpleCV repository:

sudo apt-get install ipython python-opencv python-scipy python-numpy python-pygame python-setuptools git
git clone https://github.com/sightmachine/SimpleCV.git
Expand All @@ -110,7 +110,7 @@ then just run 'simplecv' from the shell.

### Virtualenv

This is how to install SimpleCV under a python virtual environment [virtualenv] (http://www.virtualenv.org). This maybe useful in cases where you want to keep your system libraries clean and not install extra libraries. This method has only been tested on Ubuntu 12.04, it maybe possible to port to other operating systems.
This is how to install SimpleCV under a Python virtual environment [virtualenv] (http://www.virtualenv.org). This may be useful in cases where you want to keep your system libraries clean and not install extra libraries. This method has only been tested on Ubuntu 12.04, it may be possible to port to other operating systems.

Run the following commands:

Expand All @@ -130,109 +130,112 @@ Run the following commands:
./bin/python src/pygame-pygame-6625feb3fc7f/setup.py -setuptools install
./bin/pip install https://github.com/sightmachine/SimpleCV/zipball/develop





<a id="archlinux"></a>
### Arch Linux
Install using pip
Install using pip:

pacman -S python2-numpy opencv2.4.4_1 python-pygame python2-setuptools ipython2 python2-pip
pip install https://github.com/sightmachine/SimpleCV/zipball/develop

Install using clone of SimpleCV repository
Install using a clone of the SimpleCV repository:

pacman -S python2-numpy opencv2.4.4_1 python-pygame python2-setuptools ipython2
git clone https://github.com/sightmachine/SimpleCV.git
cd SimpleCV/
sudo python setup.py install

Install development version using aur
Install the development version using yaourt:

yaourt -S simplecv-git

<a id="fedora"></a>
### Fedora
#### Fedora 20 and above
#### Fedora 20 and above:

sudo yum -y install python-SimpleCV

#### Fedora 18
Install with pip
Install with pip:

sudo yum -y install python-ipython opencv-python scipy numpy pygame python-setuptools python-pip
sudo python-pip install https://github.com/sightmachine/SimpleCV/zipball/develop

Install using clone of SimpleCV repository
Install using a clone of the SimpleCV repository:

sudo yum -y install python-ipython opencv-python scipy numpy pygame python-setuptools python-pip git
git clone https://github.com/sightmachine/SimpleCV.git
cd SimpleCV/
sudo python setup.py install

<a id="macos">
### Mac OS X (10.6 and above)
<a id="os-x-106-and-above">
### OS X (Mac, 10.6 and above)
</a>

**General OSX Overview**
**General OS X Overview**

Note: We originally tried to bundle all Mac dependencies in a superpack. This turned out to be extremely difficult with the many differences between versions of Mac OS. Now, with Mac, you must build from source and we will try and make it as easy as possible. Please report a bug if you have issues.
Note: We originally tried to bundle all OS X dependencies in a superpack. This turned out to be extremely difficult with the many differences between the versions of OS X. Now, for OS X, you must build from source and we will try and make it as easy as possible. Please report a bug if you have issues.


---------------------------
**Explicit (as in every step) instructions compliments of JHawkins**

*These instructions are geared towards people who are just getting started with python development on OSX. They will walk you through setting up all the tools you need to build SimpleCV from scratch. If you don't know which instructions you want, you probably want to use these.*
*These instructions are geared towards people who are just getting started with Python development on OS X. They will walk you through setting up all the tools you need to build SimpleCV from scratch. If you don't know which instructions you want, you probably want to use these.*

* Install Xcode via the App Store
* Start Xcode and go to Xcode >> Preferences >> Downloads. Click "Install" next to Command Line Tools. (Or type "xcode-select --install" in the Terminal and select the "Install" button from the dialogue that appears.)
* If Terminal is already running, shut it down and reopen it

Install Xcode via App Store
Start Xcode and go to Xcode >> Preferences >> Downloads >> click Install across from Command Line Tools
If Terminal is already running, shut it down and reopen it
OS X's permissions on /usr/local are too restrictive and must be changed via:

sudo chown -R `whoami` /usr/local

Install homebrew via Terminal using:
Install Homebrew via Terminal using:

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Ignore the single warning that instructs you to install Xcode's CLI tools (you did that already)
To verify that homebrew is installed correctly and working, run:
Ignore the single warning that instructs you to install Xcode's CLI tools (you did that already).

To verify that Homebrew is installed correctly and working, run:

brew doctor

Address any errors before moving on. Remember, Google is your friend.
Note: If you run VM's on my via Parallels and run into multiple warnings related to "osxfuse" thi go to System Preferences >> FUSE for OS X >> Click Remove OSXFUSE. I can add it back later if needed.

Note: If you run VM's via Parallels and run into multiple warnings related to "osxfuse", just:
* Go to System Preferences >> FUSE for OS X
* Click Remove OSXFUSE (You can add it back later if needed.)

Once the doctor tells you that you are 'raring to brew', run:

brew update

followed by
followed by:

brew upgrade
brew upgrade --all

Install OpenCV via homebrew by running:
Install OpenCV via Homebrew by running:

brew tap homebrew/science
brew install opencv

Be sure to add the requested line to you ~/.bash_profile:
Be sure to add the requested line to your ~/.bash_profile:

export PYTHONPATH="/usr/local/lib/python2.7/site-packages:$PYTHONPATH"

Source your ~/.bash_profile file so that the changes take effect:

source ~/.bash_profile

Install Git via homebrew by running:
Install Git via Homebrew by running (not needed on all versions of OS X, check by running git --version):

brew install git

Install SDL dependencies (can anyone clarify this?) via homebrew by running:
Install SDL dependencies (can anyone clarify this?) via Homebrew by running:

brew install sdl sdl_image sdl_mixer sdl_ttf portmidi

Install XQuartz from https://xquartz.macosforge.org

Homebrew can't install smpeg at the time of this writing however there is a workaround:

brew tap homebrew/headonly
Expand All @@ -243,47 +246,65 @@ Download PIL:

curl -O -L http://effbot.org/media/downloads/Imaging-1.1.7.tar.gz

In the unpacked folder:
Unpack and install:

tar xvfz Imaging-1.1.7.tar.gz
cd Imaging-1.1.7
python setup.py build --force
sudo python setup.py install

Manually create a few PIL symlinks:
Manually create a few PIL symlinks.
For OS X 10.6 (Snow Leopard):

sudo ln -s /usr/local/lib/python2.6/site-packages/cv.so /Library/Python/2.6/site-packages/cv.so
sudo ln -s /usr/local/lib/python2.6/site-packages/PIL /Library/Python/2.6/site-packages/PIL
sudo ln -s /usr/local/lib/python2.6/site-packages/cv2.so /Library/Python/2.6/site-packages/cv2.so
sudo ln -s /usr/local/lib/python2.6/site-packages/cv.py /Library/Python/2.6/site-packages/cv.py

Install PIP by running:
For OS X 10.7 (Lion) up to 10.10 (Yosemite):

sudo ln -s /usr/local/lib/python2.7/site-packages/PIL /Library/Python/2.7/site-packages/PIL
sudo ln -s /usr/local/lib/python2.7/site-packages/cv2.so /Library/Python/2.7/site-packages/cv2.so
sudo ln -s /usr/local/lib/python2.7/site-packages/cv.py /Library/Python/2.7/site-packages/cv.py

Install pip by running:

sudo easy_install pip

Install the Scipy Superpack from http://fonnesbeck.github.com/ScipySuperpack/
Install Mercurial via homebrew by running:

NOTE: Installing the Scipy Superpack might mess up your Python installation and is not strictly necessary to start with SimpleCV. It is safer to install the required packages by hand via pip on an as-needed basis.

Install Mercurial via Homebrew by running:

brew install mercurial

Install pygame via PIP by running:
Install pygame via pip by running:

sudo pip install hg+http://bitbucket.org/pygame/pygame

Install svgwrite by running:

sudo pip install svgwrite

**Note:** SimpleCV's developers made a change (for the better) here that I am including, however everything up to this point is 100% guaranteed to work, because it's exactly what I did. Keeping true to that, I'll present both options. *We both suggest using the develop branch.*
**Developer's Instructions** Install SimpleCV from the git repo and then run setup.
**Note:** SimpleCV's developers made a change (for the better) here that I am including, however everything up to this point is 100% guaranteed to work, because it's exactly what I did. Keeping true to that, I'll present both options.
*We both suggest using the develop branch.*

**Developer's Instructions**

Install SimpleCV from the Git repo and then run setup:

git clone https://github.com/sightmachine/SimpleCV.git
cd SimpleCV/
sudo python setup.py install

**JHawkins' Instructions** Install SimpleCV via PIP by running:
**JHawkins' Instructions**

Install SimpleCV via pip by running:

sudo pip install https://github.com/sightmachine/SimpleCV/zipball/master

Test by running simplecv in the command line:
Test by running simplecv from the command line:

simplecv

Expand All @@ -294,14 +315,14 @@ If it starts (it should!) be sure to check out:
--------------------------------
**Lion Take Two**

*This is the abridged set of the instructions. It assumes you have most of the common OSX developer tools installed like brew and pip.
If you don't know what Brew or Pip are you probably want to use the instructions above. For OSX Lion make sure you install Mercurial (aka hg - brew install hg). There may be errors in pygame associated with not installing X11,
*This is the abridged set of the instructions. It assumes you have most of the common OS X developer tools installed like brew and pip.
If you don't know what brew or pip are you probably want to use the instructions above. For OS X Lion make sure you install Mercurial (aka hg - brew install hg). There may be errors in pygame associated with not installing X11,
if you encounter this problem please submit an issue on github.*

Before you begin installing SimpleCV make sure you have the folliwng tools installed.

* Install Xcode https://developer.apple.com/xcode/ and then run the Xcode installer.
* Install homebrew https://github.com/mxcl/homebrew/wiki/installation
* Install Homebrew https://github.com/mxcl/homebrew/wiki/installation


Commands (for Lion)::
Expand All @@ -310,7 +331,7 @@ Commands (for Lion)::
cd ~/Code
/usr/bin/ruby -e "$(curl -fsSL https://raw.github.com/gist/323731)"
brew tap homebrew/science
brew install opencv
brew install opencv
brew install git
brew tap homebrew/headonly
brew install --HEAD smpeg
Expand Down Expand Up @@ -398,8 +419,8 @@ This file will be around 192mb .
Step 2
------

After Downloading run the file . It will start an installation window along with a command prompt window. Give yes permission and press next . First it will install python 2.7.3 .
Then it will install numpy,scipy,Pygame,openCV and now all the normal installation windows will be closed and still there will be command prompt running . Leave it as such it will
After Downloading run the file. It will start an installation window along with a command prompt window. Give yes permission and press next. First it will install Python 2.7.3 .
Then it will install numpy, scipy, Pygame, openCV and now all the normal installation windows will be closed and still there will be command prompt running . Leave it as such it will
download some other file like cython and when it is finished commandpromt will display a success message "SimpleCV installed successfully" "press any button in 10sec or will close
automatically " . Now just press any button or wait for the count down .

Expand Down