Metadata-Version: 2.5
Name: fury
Version: 2.1.0
Summary: FURY - Free Unified Rendering in pYthon. A free and open-source software library for Scientific Visualization and 3D animations
Project-URL: Documentation, https://fury.gl
Project-URL: Source, https://github.com/fury-gl/fury
Project-URL: Tracker, https://github.com/fury-gl/fury/issues
Author-email: Eleftherios Garyfallidis <fury@python.org>, Serge Koudoro <fury@python.org>, Maharshi Gor <fury@python.org>, Javier Guaje <fury@python.org>, Marc-Alexandre Côté <fury@python.org>, Soham Biswas <fury@python.org>, David Reagan <fury@python.org>, Nasim Anousheh <fury@python.org>, Filipi Silva <fury@python.org>, Geoffrey Fox <fury@python.org>
Maintainer-email: FURY Developers <fury@python.org>
License: Copyright (c) 2014–2026, FURY - Free Unified Rendering in Python. All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the FURY - Free Unified Rendering in Python
          nor the names of its contributors may be used to endorse or promote
          products derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: AUTHORS.rst
License-File: LICENSE
Keywords: 3D,3D rendering,Physically based rendering,Scientific Visualization,animation,networks,physics,physics engine,shaders,simulation,visualization
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12
Requires-Dist: aiohttp
Requires-Dist: glfw>=2.7.0
Requires-Dist: lazy-loader>=0.4
Requires-Dist: numpy>=2.0
Requires-Dist: packaging>=23.0
Requires-Dist: pillow>=10.4.0
Requires-Dist: polyxios>=0.2.0
Requires-Dist: pygfx>=0.16.0
Requires-Dist: scipy>=1.13.0
Provides-Extra: all
Requires-Dist: ablog>=0.11.1; extra == 'all'
Requires-Dist: build; extra == 'all'
Requires-Dist: coverage; extra == 'all'
Requires-Dist: data-science-types; extra == 'all'
Requires-Dist: dipy; extra == 'all'
Requires-Dist: gitpython; extra == 'all'
Requires-Dist: imgui-bundle; extra == 'all'
Requires-Dist: jupyter-rfb; extra == 'all'
Requires-Dist: matplotlib>=3.9.0; extra == 'all'
Requires-Dist: mypy; extra == 'all'
Requires-Dist: nibabel; extra == 'all'
Requires-Dist: numba; extra == 'all'
Requires-Dist: numpydoc; extra == 'all'
Requires-Dist: opencv-python; extra == 'all'
Requires-Dist: pre-commit; extra == 'all'
Requires-Dist: pydata-sphinx-theme==0.15.2; extra == 'all'
Requires-Dist: pypandoc-binary; extra == 'all'
Requires-Dist: pyside6; extra == 'all'
Requires-Dist: pytest!=5.3.4; extra == 'all'
Requires-Dist: pytest-cov; extra == 'all'
Requires-Dist: pytest-doctestplus; extra == 'all'
Requires-Dist: ruff; extra == 'all'
Requires-Dist: sphinx-copybutton; extra == 'all'
Requires-Dist: sphinx-gallery>=0.10.0; extra == 'all'
Requires-Dist: sphinx-sitemap; extra == 'all'
Requires-Dist: sphinx<9.0.0,>=6.1.2; extra == 'all'
Requires-Dist: sphinxext-opengraph; extra == 'all'
Requires-Dist: texext; extra == 'all'
Requires-Dist: twine; extra == 'all'
Requires-Dist: types-pillow; extra == 'all'
Provides-Extra: compute
Requires-Dist: numba; extra == 'compute'
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: data-science-types; extra == 'dev'
Requires-Dist: gitpython; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pypandoc-binary; extra == 'dev'
Requires-Dist: pytest!=5.3.4; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-doctestplus; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: types-pillow; extra == 'dev'
Provides-Extra: doc
Requires-Dist: ablog>=0.11.1; extra == 'doc'
Requires-Dist: dipy; extra == 'doc'
Requires-Dist: imgui-bundle; extra == 'doc'
Requires-Dist: jupyter-rfb; extra == 'doc'
Requires-Dist: matplotlib>=3.9.0; extra == 'doc'
Requires-Dist: nibabel; extra == 'doc'
Requires-Dist: numpydoc; extra == 'doc'
Requires-Dist: pydata-sphinx-theme==0.15.2; extra == 'doc'
Requires-Dist: pyside6; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx-gallery>=0.10.0; extra == 'doc'
Requires-Dist: sphinx-sitemap; extra == 'doc'
Requires-Dist: sphinx<9.0.0,>=6.1.2; extra == 'doc'
Requires-Dist: sphinxext-opengraph; extra == 'doc'
Requires-Dist: texext; extra == 'doc'
Provides-Extra: medical
Requires-Dist: dipy; extra == 'medical'
Requires-Dist: nibabel; extra == 'medical'
Provides-Extra: optional
Requires-Dist: dipy; extra == 'optional'
Requires-Dist: imgui-bundle; extra == 'optional'
Requires-Dist: jupyter-rfb; extra == 'optional'
Requires-Dist: matplotlib>=3.9.0; extra == 'optional'
Requires-Dist: nibabel; extra == 'optional'
Requires-Dist: numba; extra == 'optional'
Requires-Dist: opencv-python; extra == 'optional'
Requires-Dist: pyside6; extra == 'optional'
Provides-Extra: plot
Requires-Dist: matplotlib>=3.9.0; extra == 'plot'
Provides-Extra: style
Requires-Dist: pre-commit; extra == 'style'
Requires-Dist: ruff; extra == 'style'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest!=5.3.4; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-doctestplus; extra == 'test'
Provides-Extra: typing
Requires-Dist: data-science-types; extra == 'typing'
Requires-Dist: mypy; extra == 'typing'
Requires-Dist: types-pillow; extra == 'typing'
Provides-Extra: window
Requires-Dist: imgui-bundle; extra == 'window'
Requires-Dist: jupyter-rfb; extra == 'window'
Requires-Dist: pyside6; extra == 'window'
Description-Content-Type: text/markdown

<h1 align="center">
  <br>
  <a href="https://fury.gl/"><img src="https://raw.githubusercontent.com/fury-gl/fury/refs/heads/master/docs/source/_static/images/logo.svg" alt="FURY" width="200"></a>
  <br>Free Unified Rendering in Python<br>

</h1>

<h4 align="center">A software library for scientific visualization in Python.
</h4>

<p align="center">
<a href="https://github.com/fury-gl/fury/actions/workflows/test.yml"><img src="https://github.com/fury-gl/fury/actions/workflows/test.yml/badge.svg?branch=master" alt="FURY Tests"></a>
<a href="https://pypi.org/project/fury/"><img src="https://img.shields.io/pypi/v/fury.svg" alt="PyPI version"></a>
<a href="https://anaconda.org/conda-forge/fury"><img src="https://anaconda.org/conda-forge/fury/badges/version.svg" alt="Conda-forge version"></a>
<a href="https://doi.org/10.21105/joss.03384"><img src="https://joss.theoj.org/papers/10.21105/joss.03384/status.svg" alt="JOSS paper"></a>

</p>

<p align="center">
  <a href="#general-information">General Information</a> •
  <a href="#key-features">Key Features</a> •
  <a href="#installation">Installation</a> •
  <a href="#how-to-use">How to use</a> •
  <a href="#credits">Credits</a> •
  <a href="#friends--support">Friends &amp; Support</a> •
  <a href="#contribute">Contribute</a> •
  <a href="#citing">Citing</a>
</p>

<div align="center">

<table align="center">
  <tr>
    <th align="center">Interactive 3D Flight Simulator</th>
    <th align="center">Rotating 4D Tesseract</th>
  </tr>
  <tr>
    <td align="center"><a href="https://fury.gl/latest/auto_examples/04_demos/viz_flight_simulator.html"><img src="https://fury.gl/latest/_images/sphx_glr_viz_flight_simulator_001.gif" alt="FURY flight simulator with an aircraft, runway, and procedural landscape" width="420"></a></td>
    <td align="center"><a href="https://fury.gl/latest/auto_examples/04_demos/viz_tesseract.html"><img src="https://fury.gl/latest/_images/sphx_glr_viz_tesseract_001.gif" alt="Animated projection of a rotating four-dimensional tesseract in FURY" width="420"></a></td>
  </tr>
</table>

Click a demo to explore its tutorial and source code.

</div>

# General Information

- **Website and Documentation:** https://fury.gl
- **Tutorials and examples:** 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
- **Download releases:** https://pypi.org/project/fury/
- **Issue tracker:** https://github.com/fury-gl/fury/issues
- **Free software:** [3-clause BSD license](LICENSE)
- **Community:** Come to chat on [Discord](https://discord.gg/6btFPPj)

# Key Features

- GPU-accelerated scientific visualization with pygfx and WebGPU.
- NumPy-based 3D actors and interactive volume slices.
- Built-in user interface components.
- Keyframe, camera, and timeline animation.
- GPU-based force-directed network visualization.
- Mesh, point, and line loading powered by [Polyxios](https://polyxios.org/), with an extensive range of 3D mesh and geometry file extensions, including `.obj`, `.ply`, `.stl`, `.off`, `.vtk`, `.vtp`, and `.vtu`. See the [full list of Polyxios-supported formats and extensions](https://polyxios.org/stable/formats/index.html) for format details and requirements.

# Installation

The current development version of FURY requires Python 3.12 or newer.
Python 3.12, 3.13, and 3.14 are
supported stable versions, tested in blocking Linux, macOS, and Windows CI.
Python 3.12 support will be removed in an upcoming FURY release.

## Releases

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

Published releases may have different Python requirements; see the package metadata for the release you install.

For optional Qt, Jupyter, and ImGui window backends:

    pip install "fury[window]"

## Development

### Installation from source

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

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

**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/topics/local-project-installs/#regular-installs) using:

    pip install .

Or as an ["editable" installation](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs) using:

    pip install -e .

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

**Step 4:** Enjoy!

For more information, see the [development installation guide](docs/source/installation.rst).

## Testing

From the repository root (the directory containing `pyproject.toml`), install test suite requirements:

    pip install -r requirements/test.txt

Launch the test suite from the same repository root:

    pytest -svv fury


# How to use

Start with Quick Visualization below.

<div align="center">

| Tutorial | Description |
|:--------:|:-----------:|
| [Quick Visualization](https://fury.gl/latest/auto_examples/01_introductory/viz_show.html) | Create and display a first 3D scene |
| [Force-Directed Network Visualization](https://fury.gl/latest/auto_examples/04_demos/viz_network.html) | Explore a GPU-based network layout |
| [3D Image Slicer](https://fury.gl/latest/auto_examples/04_demos/viz_slicer.html) | Display and interact with volume slices |
| [UI Sliders](https://fury.gl/latest/auto_examples/07_ui/viz_sliders.html) | Add interactive controls |
| [Keyframe Animation](https://fury.gl/latest/auto_examples/10_animation/viz_fury_animation.html) | Animate camera movement and opacity |

</div>

Explore the full [tutorials and examples gallery](https://fury.gl/latest/auto_examples/index.html).
Some examples require optional dependencies or download example data; follow the instructions in each tutorial.

Upgrading from VTK-based FURY 0.12.x? See the [FURY 2 migration guide](https://fury.gl/latest/migration_guide_v2.0.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.


# Friends & Support

- [DIPY](https://dipy.org/)
- [Polyxios](https://polyxios.org/)
- [Intelligent Systems Engineering, IU](https://luddy.iu.edu/academics/units/ise.html)
- [Google Summer of Code](https://summerofcode.withgoogle.com/)


# 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)!

See the [contribution guide](CONTRIBUTING.rst) for development setup and contribution guidelines.

# 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


```bibtex
    @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}
    }
```
