Rishi Verma created CLIMATE-660:
-----------------------------------
Summary: User guide suggestions
Key: CLIMATE-660
URL: https://issues.apache.org/jira/browse/CLIMATE-660
Project: Apache Open Climate Workbench
Issue Type: Documentation
Affects Versions: 0.5
Environment: Ubuntu Server 15.04
Reporter: Rishi Verma
Priority: Minor
Fix For: 1.0.0
A few suggestions for the user-guide:
[https://cwiki.apache.org/confluence/display/CLIMATE/Getting+Started#]
* The "Make Everything Easier" section's code snippet is missing an end quote:
i.e. change the first line to be the second
** {{export PYTHONPATH="$HOME/climate/:$HOME/climate/ocw/:$PYTHONPATH}}
** {{export PYTHONPATH="$HOME/climate/:$HOME/climate/ocw/":$PYTHONPATH}}
* The "Install Additional Dependencies" section should have a WARNING to inform
the user they should "deactivate" their virtual environment, complete the
section "Make Everything Easier" and then re-activate their virtual environment
if they chose the "Option 1: Install Anaconda and various other dependencies"
option under the section "Install Conda Dependencies". There are virtualenv /
conda configuration conflicts if the above is not completed.
* The "Test Your Installation section" should have a TIP to suggest the user
upgrade libpng library to libpng16. I'm running a fresh Ubuntu Server 15.04
with kernel 3.19, and I had to manually upgrade libpng12 to libpng16 for the
demo to work. (see:
http://geeksww.com/tutorials/libraries/libpng/installation/installing_libpng_on_ubuntu_linux.php,
and http://sourceforge.net/projects/libpng/files/libpng16/)
[https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=31824167]
* C python libraries (e.g. Python.h) are required, but a fresh Ubuntu doesn't
include these libraries. I had to run {{sudo apt-get install python-dev}} as a
pre-requisite. This step should be included.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
