Wednesday, May 20, 2015

Haoyu's Installation Notes for Open Science Framework(OSF)

Firstly, make sure you all the official docs. There are two options.

  • Simplified installation instructions:
          https://github.com/CenterForOpenScience/osf.io

  • More Detailed Instructions:
         http://cosdev.readthedocs.org/en/latest/osf/setup.html

However, after installing OSF by myself, it works only when I combine both instructions above. Here are the steps I followed.


Pre-Installation Steps:



  • Make sure you have brew and pip installed firstly.
  • Then you need to install Xcode and Java.
  • Set up virtual environment 

Quick Steps:

1. Copy the OSF to your machine
Navigate to where you want the OSF installed, and run
git clone  https://github.com/CenterForOpenScience/osf.io.git
2. From the Terminal, enter your virtual environment
workon osf
3. Create a local settings file
Navigate to the osf.io directory, and run
cp website/settings/local-dist.py website/settings/local.py
3. Install invoke and then use it to start the setup process
pip install invoke
invoke setup
After running commands above, then you could use brew list to check whether you install them all correctly.


Notes: when you use brew to install libraries, remember to use `brew doctor` and then it will give you suggestions about how to make your library work well.


Detailed Steps:

Basically, It is the steps in this link--http://cosdev.readthedocs.org/en/latest/osf/setup.html



Important Notes: For both steps: before you run invoke setup and invoke addon_requirements, you have to install libraries in requirements.txt firstly. In another words, run the command:
pip install -r requirements.txt 

Problems I went through:

1. Permission Denied. It always gives me permission denied error. When I install something during which it need to access to library folder. 

Solution: Because I use a computer which was used by another intern before. So there is some folders that I don't have permissions. In that case, I need to run the code below:
sudo chown -R haoyuchen /usr/local/Library
So generally, it should be sudo chown -R username /folderyouwantchange

2. when I run invoke setup or invoke addon_requirements, it gives me error that the file in x11 is not found. 

Solutions:
It is because both invoke setup and invoke addon_requirements need to use some dependent libraries.
  • The easy solution is to get the link set up:
The solution is from the link: http://stackoverflow.com/questions/11465258/xlib-h-not-found-when-building-graphviz-on-mac-os-x-10-8-mountain-lion

  • Or DO :  xcode-select --install

However, the fundamental reason is that I don't install the libraries completely. Because in these steps, it misses the one to install the library in requirments.txt.
pip install -r requirements.txt 
One thing should be careful is that lxml couldn't be installed by the command above. when you don't install the two dependent libraries for lxml, it will stop the command. So I choose to comment `lxml==3.4.1`  in requirements.txt. And manually install lxml by command line below.
     STATIC_DEPS=true pip install lxml

Notes from official doc of lxml:
If you want to use lxml together with the official libxml2 Python bindings (maybe because one of your dependencies uses it), you must build lxml statically. Otherwise, the two packages will interfere in places where the libxml2 library requires global configuration, which can have any kind of effect from disappearing functionality to crashes in either of the two.

3.Every time when I run xcode-select --install, it gave a window and then I selected install but it always gives me error that the network has problem. 

Solution: http://stackoverflow.com/questions/19691701/failed-to-install-command-line-tools-on-osx-mavericks

Basically, it suggests to install the command line tool by directly downloading it from official website.

4. When you get a error message that shows it can't import URITemplate.

It is because that in github3 already install URITemplate, so it causes problem when install it twice. 
Solution -- Run the following three commands:
pip uninstall github3.py
pip uninstall uritemplate.py
pip install github3.py

Note: This solution is from this link: https://github.com/sigmavirus24/github3.py/issues/328

5. When you get error about django problem, see the screenshot below:


You need to consider about trying to install the requirements again:

$ invoke requirements