{"action":"created","comment":{"url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments/74623177","id":74623177,"diff_hunk":"@@ -0,0 +1,219 @@\n+# Firefly\n+\n+Firefly is IPAC's Advanced Astronomy WEB UI Framework. It is for building a web-based Front end to access science archives. It provides sophisticated data visualization capabilities not available in many web-based archives. Our efforts to create a tightly integrated and user-friendly interface has generated numerous positive feedback from scientists. Users can browse and understand large volumes of archive data in a fraction of the time it took in the past.\n+\n+Note - if you are pulling, look at the [branches section](#branches)\n+\n+\n+#### Firefly Framework\n+Firefly is being reused for various archives because it is a framework of archive components. This has allowed us now to implement multiple archive systems at a fraction of the cost of the first system, Spitzer Heritage Archive.\n+\n+\n+#### Firefly Viewer\n+\n+By default, this repository builds a default example webapp. This tool can be used for viewing FITS data, catalogs, and xyplots. It is a general viewer tool for retrieving and viewing astronomy related data.\n+\n+#### Firefly Tools\n+\n+Firefly Tools exposes the most powerful components of Firefly in a way that can be used by any web page with no prerequisites. It allows any web developer access to Firefly's FITS visualizers or Table Tool with just a very few lines of JavaScript. The goal is to make these tools very easy to use with only a 10 minute learning curve.\n+\n+An important feature is that the Firefly Tools server can be installed cross-site. In other words, it is not required to be on the same server as the web page. Firefly Tools can do this because it uses JSONP or CORS for the server communication. This allows Firefly Tools not to be limited by the server's Same Origin Policy and to give the developer a lot of flexibility. The web developer does not have to do any installation, but can simply just start using Firefly Tools.\n+\n+### Visualizers\n+The firefly components contain 3 main visualizers for astronomy data.\n+\n+\n+#### Tabular Display\n+Firefly has implemented “Excel-like” tables on the webpage. In an easy, interactive way, a user can sort the results, filter the data on multiple constraints, hide or show columns or select data for download or visualization. The Firefly Tools server is optimized to show very large tables without significant performance degradation. We have tested it with over 10 million rows, 50 column tables.\n+\n+#### FITS Visualization\n+Firefly provides a first-class FITS visualization on the Web without any plugins. All of the significant components you would expect to see in a basic desktop FITS application are available with data that Firefly displays. The FITS visualizer allows for plotting anything that the table shows that has a Lon and Lat. Therefore, users can overlay multiple catalogs over their FITS image and interact with it.\n+\n+#### 2D Line Graphs\n+Firefly shows 2D line graphs interactively so that a user can read the data point values as he moves his mouse around or zooms in to investigate the data at a finer level. These graphs are used for spectrum or plotting table columns. The user can specify any column that the tables are showing. The user can also define equations from the rows for the XY Plot, such as (row1*row2/tan(row3))\n+\n+## Branches\n+There are several branches the this repository.  Here are the ones that you should care about.\n+\n+ - rc: the next release canidate branch.  This is the most stable branch.\n+ - master: Update once a week.  Used for out stable, weekly build.\n+ - dev: this branch is could be updated every day. It is the active development branch. It is not stable.\n+ - x-??? : Any branch that begins with x- is temporary and used development feature branches\n+\n+\n+## Setup\n+\n+#### Prerequisites\n+ -  [Java 1.8] http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html\n+    This is the version we are using to compile and run Firefly.\n+\n+ -  [Gradle 2.3+] (https://gradle.org/downloads)\n+    Gradle is an open source build automation system.\n+\n+\n+ -  [Tomcat 7+] (http://tomcat.apache.org/download-70.cgi)\n+    Apache Tomcat is an open source software implementation of the Java Servlet and JavaServer Pages technologies.\n+\n+ -  [Node 0.12.0.+] (https://nodejs.org/download/)\n+    Javascript interpreter for command line environment, used for development tools\n+","path":"docs/fireflyOverView.md","position":59,"original_position":59,"commit_id":"2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd","original_commit_id":"99b338baf8bf7d921560695674d4f8cdfe4d50f0","user":{"login":"tgoldina","id":11876160,"avatar_url":"https://avatars.githubusercontent.com/u/11876160?v=3","gravatar_id":"","url":"https://api.github.com/users/tgoldina","html_url":"https://github.com/tgoldina","followers_url":"https://api.github.com/users/tgoldina/followers","following_url":"https://api.github.com/users/tgoldina/following{/other_user}","gists_url":"https://api.github.com/users/tgoldina/gists{/gist_id}","starred_url":"https://api.github.com/users/tgoldina/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tgoldina/subscriptions","organizations_url":"https://api.github.com/users/tgoldina/orgs","repos_url":"https://api.github.com/users/tgoldina/repos","events_url":"https://api.github.com/users/tgoldina/events{/privacy}","received_events_url":"https://api.github.com/users/tgoldina/received_events","type":"User","site_admin":false},"body":"The 4 items above do not show as links. Perhaps, we should put them in the form `[text](link)` with no spaces. Is this file replacing README.md?","created_at":"2016-08-12T16:50:18Z","updated_at":"2016-08-12T16:50:18Z","html_url":"https://github.com/Caltech-IPAC/firefly/pull/142#discussion_r74623177","pull_request_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142","_links":{"self":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments/74623177"},"html":{"href":"https://github.com/Caltech-IPAC/firefly/pull/142#discussion_r74623177"},"pull_request":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142"}}},"pull_request":{"url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142","id":81034069,"html_url":"https://github.com/Caltech-IPAC/firefly/pull/142","diff_url":"https://github.com/Caltech-IPAC/firefly/pull/142.diff","patch_url":"https://github.com/Caltech-IPAC/firefly/pull/142.patch","issue_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142","number":142,"state":"open","locked":false,"title":"DM-7038-JSDoc","user":{"login":"lznakano","id":11981693,"avatar_url":"https://avatars.githubusercontent.com/u/11981693?v=3","gravatar_id":"","url":"https://api.github.com/users/lznakano","html_url":"https://github.com/lznakano","followers_url":"https://api.github.com/users/lznakano/followers","following_url":"https://api.github.com/users/lznakano/following{/other_user}","gists_url":"https://api.github.com/users/lznakano/gists{/gist_id}","starred_url":"https://api.github.com/users/lznakano/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lznakano/subscriptions","organizations_url":"https://api.github.com/users/lznakano/orgs","repos_url":"https://api.github.com/users/lznakano/repos","events_url":"https://api.github.com/users/lznakano/events{/privacy}","received_events_url":"https://api.github.com/users/lznakano/received_events","type":"User","site_admin":false},"body":"To look at the doc, please open jsdoc/index.html file.  I have edited the source files (.js and .jsx) to add document tags, add parameter' types and names etc to the best of my knowledge.  Please examine the them and let me know  of any of them are wrong.  I am sure some of them are not right. \r\n\r\nNOTE: \r\nModule:  it is for documentation purpose only, lowLevelApi and highLevelApi are just for listing the method/function etc in two category.  \r\n\r\nKnown issue:\r\n1.  The sorting in the template uses longname (path+methodName).  \r\n2.  The README.md file can be accepted by jsdoc, however, it does not translate the links inside    README.md file correctly.  Thus, I used a fireflyOverView.md instead.  There is an option to copy the static files but apparently, it does not work as it was described. \r\n3. I put the example markdown file into tutorial directory\r\n\r\nPlease read it through and let me know your comments and suggestions.  \r\n\r\nThanks!\r\n\r\nLZ\r\n\r\n\r\n","created_at":"2016-08-11T21:27:00Z","updated_at":"2016-08-12T16:50:18Z","closed_at":null,"merged_at":null,"merge_commit_sha":"2b01f258648ef1f9c994610f994cdb28732ef861","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/commits","review_comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/comments","review_comment_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142/comments","statuses_url":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd","head":{"label":"Caltech-IPAC:DM-7038-JSDoc","ref":"DM-7038-JSDoc","sha":"2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd","user":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"repo":{"id":33508214,"name":"firefly","full_name":"Caltech-IPAC/firefly","owner":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Caltech-IPAC/firefly","description":"","fork":false,"url":"https://api.github.com/repos/Caltech-IPAC/firefly","forks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/forks","keys_url":"https://api.github.com/repos/Caltech-IPAC/firefly/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Caltech-IPAC/firefly/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Caltech-IPAC/firefly/teams","hooks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/hooks","issue_events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/events{/number}","events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/events","assignees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/assignees{/user}","branches_url":"https://api.github.com/repos/Caltech-IPAC/firefly/branches{/branch}","tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/tags","blobs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/refs{/sha}","trees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/{sha}","languages_url":"https://api.github.com/repos/Caltech-IPAC/firefly/languages","stargazers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/stargazers","contributors_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contributors","subscribers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscribers","subscription_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscription","commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/commits{/sha}","git_commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/commits{/sha}","comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/comments{/number}","issue_comment_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/comments{/number}","contents_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contents/{+path}","compare_url":"https://api.github.com/repos/Caltech-IPAC/firefly/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Caltech-IPAC/firefly/merges","archive_url":"https://api.github.com/repos/Caltech-IPAC/firefly/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Caltech-IPAC/firefly/downloads","issues_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues{/number}","pulls_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls{/number}","milestones_url":"https://api.github.com/repos/Caltech-IPAC/firefly/milestones{/number}","notifications_url":"https://api.github.com/repos/Caltech-IPAC/firefly/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Caltech-IPAC/firefly/labels{/name}","releases_url":"https://api.github.com/repos/Caltech-IPAC/firefly/releases{/id}","deployments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/deployments","created_at":"2015-04-06T22:03:13Z","updated_at":"2016-05-06T19:30:48Z","pushed_at":"2016-08-12T16:49:48Z","git_url":"git://github.com/Caltech-IPAC/firefly.git","ssh_url":"git@github.com:Caltech-IPAC/firefly.git","clone_url":"https://github.com/Caltech-IPAC/firefly.git","svn_url":"https://github.com/Caltech-IPAC/firefly","homepage":null,"size":170037,"stargazers_count":3,"watchers_count":3,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":5,"forks":1,"open_issues":5,"watchers":3,"default_branch":"dev"}},"base":{"label":"Caltech-IPAC:dev","ref":"dev","sha":"3cadbe8640a8acb8a26a757f422d09a234014669","user":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"repo":{"id":33508214,"name":"firefly","full_name":"Caltech-IPAC/firefly","owner":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Caltech-IPAC/firefly","description":"","fork":false,"url":"https://api.github.com/repos/Caltech-IPAC/firefly","forks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/forks","keys_url":"https://api.github.com/repos/Caltech-IPAC/firefly/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Caltech-IPAC/firefly/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Caltech-IPAC/firefly/teams","hooks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/hooks","issue_events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/events{/number}","events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/events","assignees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/assignees{/user}","branches_url":"https://api.github.com/repos/Caltech-IPAC/firefly/branches{/branch}","tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/tags","blobs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/refs{/sha}","trees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/{sha}","languages_url":"https://api.github.com/repos/Caltech-IPAC/firefly/languages","stargazers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/stargazers","contributors_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contributors","subscribers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscribers","subscription_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscription","commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/commits{/sha}","git_commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/commits{/sha}","comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/comments{/number}","issue_comment_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/comments{/number}","contents_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contents/{+path}","compare_url":"https://api.github.com/repos/Caltech-IPAC/firefly/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Caltech-IPAC/firefly/merges","archive_url":"https://api.github.com/repos/Caltech-IPAC/firefly/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Caltech-IPAC/firefly/downloads","issues_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues{/number}","pulls_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls{/number}","milestones_url":"https://api.github.com/repos/Caltech-IPAC/firefly/milestones{/number}","notifications_url":"https://api.github.com/repos/Caltech-IPAC/firefly/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Caltech-IPAC/firefly/labels{/name}","releases_url":"https://api.github.com/repos/Caltech-IPAC/firefly/releases{/id}","deployments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/deployments","created_at":"2015-04-06T22:03:13Z","updated_at":"2016-05-06T19:30:48Z","pushed_at":"2016-08-12T16:49:48Z","git_url":"git://github.com/Caltech-IPAC/firefly.git","ssh_url":"git@github.com:Caltech-IPAC/firefly.git","clone_url":"https://github.com/Caltech-IPAC/firefly.git","svn_url":"https://github.com/Caltech-IPAC/firefly","homepage":null,"size":170037,"stargazers_count":3,"watchers_count":3,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":5,"forks":1,"open_issues":5,"watchers":3,"default_branch":"dev"}},"_links":{"self":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142"},"html":{"href":"https://github.com/Caltech-IPAC/firefly/pull/142"},"issue":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142"},"comments":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142/comments"},"review_comments":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/comments"},"review_comment":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/commits"},"statuses":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd"}}}}
{"actor":{"display_login":"tgoldina"}}