Skip to content

mshiferaw/Firefly

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Firefly

Firefly snapshot

Firefly is an interactive particle viewer designed for FIRE data, written in WebGL using the three.js library. A live version is available here.

Installation

To install Firefly (on any operating system), please clone this GitHub repository :

$ git clone https://github.com/ageller/Firefly.git

Or, if you prefer, you can download the zip file and unpack it.

You will also need a browser; we recommend Firefox or Google Chrome. To import your own data into Firefly, you will also need Python; we recommend installing Anaconda Python version 3.x .

Running Firefly

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:

$ python2 -m SimpleHTTPServer
or
$ python3 -m http.server

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

This will open the data set included within this repository. If you want to use your own data, you will first need to convert your data to the format needed by Firefly. You can do this with the python tools in the data directory. Please see the wiki page for more details.

Additional Docs

Additional documentation is available on the wiki page associated with this repository.

This tool builds off of a previous version developed by Alessandro Febretti.

Acknowledgments

This project is funded by Northwestern's Center for Interdisciplinary Exploration and Research in Astrophysics (CIERA), Northwestern's IT Research Computing group, and NSF grants AST-1412836, AST-1715216, and CAREER award AST-1652522 awarded to Claude-André Faucher-Giguère.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 53.3%
  • JavaScript 31.9%
  • Python 10.7%
  • CSS 3.6%
  • HTML 0.5%