An open API service indexing awesome lists of open source software.

https://github.com/fury-gl/fury

FURY - Free Unified Rendering in pYthon.
https://github.com/fury-gl/fury

3d-graphics game-engine hacktoberfest python scientific-visualization scriptable-animations shaders simulation

Last synced: 4 months ago
JSON representation

FURY - Free Unified Rendering in pYthon.

Awesome Lists containing this project

README

          




FURY

Free Unified Rendering in Python

A software library for scientific visualization in Python.











General Information
Key Features
Installation
How to use
Credits
Contribute
Citing

| | | |
|:--------|:--------|:--------|
| FURY Networks | swarming simulation | shaders horse |
| *Network Visualization* | *Swarming/flocking simulation based on simple boids rules* | *Easy shader effect integration.* |
| sdf | Collides simulation | Physics bricks |
| *Ray Marching and Signed Distance Functions* | *Particle collisions* | *Interoperability with the [pyBullet](https://pybullet.org/wordpress/) library.* |
| UI Tabs | Shaders dragon skybox | Picking object |
| *Custom User Interfaces* | *Shaders and SkyBox integration* | *Easy picking manager* |

# General Information

- **Website and Documentation:** https://fury.gl
- **Tutorials:** https://fury.gl/latest/auto_tutorials/index.html
- **Demos:** https://fury.gl/latest/auto_examples/index.html
- **Blog:** https://fury.gl/latest/blog.html
- **Mailing list:** https://mail.python.org/mailman3/lists/fury.python.org
- **Official source code repo:** https://github.com/fury-gl/fury.git
- **Download releases:** https://pypi.org/project/fury/
- **Issue tracker:** https://github.com/fury-gl/fury/issues
- **Free software:** 3-clause BSD license
- **Community:** Come to chat on [Discord](https://discord.gg/6btFPPj)

# Key Features

- Custom User Interfaces
- Physics Engines API
- Custom Shaders
- Interactive local and Remote rendering in Jupyter Notebooks
- Large amount of Tutorials and Examples

# Installation

## Releases

`pip install fury` or `conda install -c conda-forge fury`

## Development

### Installation from source

**Step 1.** Get the latest source by cloning this repo:

git clone https://github.com/fury-gl/fury.git

**Step 2.** Install requirements:

pip install -r requirements/default.txt

**Step 3.** Install fury

As a [local project installation](https://pip.pypa.io/en/stable/reference/pip_install/#id44) using:

pip install .

Or as an ["editable" installation](https://pip.pypa.io/en/stable/reference/pip_install/#id44) using:

pip install -e .

**If you are developing fury you should go with editable installation.**

**Step 4:** Enjoy!

For more information, see also [installation page on fury.gl](https://fury.gl/latest/installation.html)

## Testing

After installation, you can install test suite requirements:

pip install -r requirements/test.txt

And to launch test suite:

pytest -svv fury

# How to use

There are many ways to start using FURY:

- Go to [Getting Started](https://fury.gl/latest/getting_started.html)
- Explore our [Tutorials](https://fury.gl/latest/auto_tutorials/index.html) or [Demos](https://fury.gl/latest/auto_examples/index.html).

# Credits

Please, go to [contributors page](https://github.com/fury-gl/fury/graphs/contributors) to see who have been involved in the development of FURY.

# Contribute

We love contributions!

You've discovered a bug or something else you want to change - excellent! Create an [issue](https://github.com/fury-gl/fury/issues/new)!

# Citing

If you are using FURY in your work then do cite [this paper](https://doi.org/10.21105/joss.03384). By citing FURY, you are helping sustain the FURY ecosystem.

Eleftherios Garyfallidis, Serge Koudoro, Javier Guaje, Marc-Alexandre Côté, Soham Biswas,
David Reagan, Nasim Anousheh, Filipi Silva, Geoffrey Fox, and Fury Contributors.
"FURY: advanced scientific visualization." Journal of Open Source Software 6, no. 64 (2021): 3384.
https://doi.org/10.21105/joss.03384

```css
@article{Garyfallidis2021,
doi = {10.21105/joss.03384},
url = {https://doi.org/10.21105/joss.03384},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {64},
pages = {3384},
author = {Eleftherios Garyfallidis and Serge Koudoro and Javier Guaje and Marc-Alexandre Côté and Soham Biswas and David Reagan and Nasim Anousheh and Filipi Silva and Geoffrey Fox and Fury Contributors},
title = {FURY: advanced scientific visualization},
journal = {Journal of Open Source Software}
}
```