semvec/pypi-packages huggingface dataset:
ViewCube 0.2.9
Datacube visualization and sonification
License: MIT
Requires Python: >=3.6
Keywords: Scientific, Astrophysics, Spectroscopy, Sonification

# ViewCube - Datacube Visualization [& Sonification] Tool

**ViewCube** is a user-friendly datacube visualizer designed to streamline the exploration and 
analysis of multi-dimensional datasets. It enables easy visualization and interaction with 
datacubes, while its **Sonicube** interface offers auditory exploration through **sonification**, 
enriching the data analysis process.

Additionally, the tool allows for the exploration of raw-stacked spectra (RSS) via its **ViewRSS** 
interface, provided a fiber position table is available.

## Documentation

For detailed information on ViewCube, visit the official documentation:

[https://viewcube.readthedocs.io](https://viewcube.readthedocs.io/)

## Installation

We recommend referring to the ViewCube documentation for comprehensive guidance:

[https://viewcube.readthedocs.io](https://viewcube.readthedocs.io/)

To get started quickly, just run:
```
pip install viewcube
```

For more information, visit the [ViewCube PyPI page](https://pypi.org/project/ViewCube/).

## Documentation

For detailed instructions and information, consult the ViewCube documentation:

[https://viewcube.readthedocs.io](https://viewcube.readthedocs.io/)

## Usage

To visualize a datacube, follow these steps:

1. Open a terminal window.
2. Navigate to the folder where your datacube file (`name_cube.fits`) is located.
3. Enter the following command:
    ```
    ViewCube name_cube.fits
    ```

The first time you run ``ViewCube`` you may need to create a configuration file:
```
ViewCube --config-file
```


## Cheat Sheet

Refer to the ``ViewCube.pdf`` cheat sheet PDF file in the GitHub latex directory or 
the [documentation](https://viewcube.readthedocs.io/) for a list of keyboard 
shortcuts and quick operations to enhance your experience.

Start exploring your datacubes with ViewCube and gain valuable insights effortlessly. For any further assistance or feedback, please refer to the documentation or reach out to our support team. Happy visualizing!

## How to cite this package

If you use this package in your research—whether for visualization, sonification, or both—please 
cite it by including as much of the following information as possible:

Adrián García Riber, Rubén García-Benito, Francisco Serradilla. *Interactive multimodal integral 
field spectroscopy*, RAS Techniques and Instruments, Volume 3, Issue 1, January 2024, Pages 748-758
[https://doi.org/10.1093/rasti/rzae049](https://doi.org/10.1093/rasti/rzae049)