search

occam-ra / occam

OCCAM Reconstructability Analysis Tools
Other
20 stars 14 forks source link

Add installation documentation #1

Closed Gooseus closed 5 years ago

Gooseus commented 5 years ago

This PR creates the start of some documentation for how to install a local copy of OCCAM that can be used for development and testing. The INSTALL.md file has documentation for using VirtualBox and Ubuntu to get OCCAM installed and running with a web interface via Apache.

In addition, the Python files in py needed to have an encoding comment added - I'm not sure if they made this a global python setting on the PSU servers, but I opted for this to avoid another configuration step. For the same reason, I also added a line to the Makefile to create the install/web/data folder.

rdjpdx commented 5 years ago

Shawn,

How difficult is it to get a Mac OS version?

Thanks. Rich

On Jan 16, 2019, at 12:39 PM, Shawn Marincas notifications@github.com wrote:

This PR creates the start of some documentation for how to install a local copy of OCCAM that can be used for development and testing. The INSTALL.md file has documentation for using VirtualBox and Ubuntu to get OCCAM installed and running with a web interface via Apache.

In addition, the Python files in py needed to have an encoding comment added - I'm not sure if they made this a global python setting on the PSU servers, but I opted for this to avoid another configuration step. For the same reason, I also added a line to the Makefile to create the install/web/data folder.

You can view, comment on, or merge this pull request online at:

https://github.com/occam-ra/occam/pull/1 https://github.com/occam-ra/occam/pull/1 Commit Summary

Add documentation on how to install OCCAM on Ubuntu to README Update Makefile and add encoding to python scripts Created INSTALL.md with fixed install instructions Add more virtualization informatation and link to Python virtual environment article File Changes

A INSTALL.md https://github.com/occam-ra/occam/pull/1/files#diff-0 (126) M Makefile https://github.com/occam-ra/occam/pull/1/files#diff-1 (1) M py/OpagCGI.py https://github.com/occam-ra/occam/pull/1/files#diff-2 (1) M py/basic.py https://github.com/occam-ra/occam/pull/1/files#diff-3 (3) M py/bp.py https://github.com/occam-ra/occam/pull/1/files#diff-4 (1) M py/common.py https://github.com/occam-ra/occam/pull/1/files#diff-5 (1) M py/distanceFunctions.py https://github.com/occam-ra/occam/pull/1/files#diff-6 (1) M py/fit.py https://github.com/occam-ra/occam/pull/1/files#diff-7 (1) M py/jobcontrol.py https://github.com/occam-ra/occam/pull/1/files#diff-8 (1) M py/ocGraph.py https://github.com/occam-ra/occam/pull/1/files#diff-9 (1) M py/occammail.py https://github.com/occam-ra/occam/pull/1/files#diff-10 (1) M py/ocutils.py https://github.com/occam-ra/occam/pull/1/files#diff-11 (1) M py/sbfit.py https://github.com/occam-ra/occam/pull/1/files#diff-12 (1) M py/sbsearch.py https://github.com/occam-ra/occam/pull/1/files#diff-13 (1) M py/weboccam.py https://github.com/occam-ra/occam/pull/1/files#diff-14 (1) Patch Links:

https://github.com/occam-ra/occam/pull/1.patch https://github.com/occam-ra/occam/pull/1.patch https://github.com/occam-ra/occam/pull/1.diff https://github.com/occam-ra/occam/pull/1.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/occam-ra/occam/pull/1, or mute the thread https://github.com/notifications/unsubscribe-auth/ATGhVFJ-Q34HwdC4FAPgyvT3HnyS53lYks5vD44NgaJpZM4aD6Aq.