Skip to content

Getting Started

Aaron Geller edited this page Apr 23, 2018 · 13 revisions

Installation

Please see here.

Launch using the data included in this repository

To start Firefly, you can simply open the index.html file with your browser. We recommend Firefox or Chrome. If you prefer Chrome, you may need to host your own server. This is easy to do by executing the following python command within the directory that contains your index.html file:

> python -m SimpleHTTPServer

Once this SimpleHTTPServer is running, you can open Chrome, and enter the url : http://localhost:8000/ . (This python step should not be necessary with Firefox, but may be necessary with other browsers.)

This will open the data set included within this repository.

Controls within Firefly

Please see here.

Using your own data

If you want to use your own data, you will first need to convert your data to the format needed by Firefly. We provide python tools to convert FIRE data. If you have data in another format, you will need to write a converter yourself (or email us and ask us to do it). We included a simple startup script in this iPython notebook within the data directory that you can use to get started. There are many options available to customize the viewer and set defaults. These are explained in detail here.

Additional Note

For very large amounts of data, you may need to increase the memory allowed in your Chrome browser. To do so, you can launch Chrome from the command line as (and change the numerical size value to something appropriate to your needs) :

> /Applications/Google\ Chrome.app/Contents/MacOS/./Google\ Chrome --args --js-flags="--max_old_space_size=8192"