Add installation documentation #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Created an Installation section of the README.md to add instructions for how to get OCCAM running on various operating systems, starting with Ubuntu 16.04 running on VirtualBox.
Updates the Makefile to include creation of the `data` folder in `install/web/`. Add `# coding=utf-8` to python scripts in `py` folder to avoid encoding errors when running.
The README.md was returned to its original state with the installation instructions copied into a new INSTALL.md file. The installation instructions were also edited to include some fixes to the dependency packages and to include some formatting changes and additional instructions on configuring Apache.
|
Shawn,
How difficult is it to get a Mac OS version?
Thanks. Rich
… On Jan 16, 2019, at 12:39 PM, Shawn Marincas ***@***.***> 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:
#1 <#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 <#1>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ATGhVFJ-Q34HwdC4FAPgyvT3HnyS53lYks5vD44NgaJpZM4aD6Aq>.
|
gdcutting
pushed a commit
that referenced
this pull request
Feb 16, 2019
Merge pull request #2 from gdcutting/master
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.mdfile 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
pyneeded 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 theMakefileto create theinstall/web/datafolder.