Metadata-Version: 2.1
Name: hciplot
Version: 0.1.8
Summary: High-contrast Imaging Plotting library
Home-page: https://github.com/carlgogo/hciplot
Author: Carlos Alberto Gomez Gonzalez, Valentin Christiaens
Author-email: valentinchrist@hotmail.com
License: MIT
Download-URL: https://github.com/carlgogo/hciplot/archive/refs/tags/v0.1.8.tar.gz
Description: [![PyPI version](https://badge.fury.io/py/hciplot.svg)](https://badge.fury.io/py/hciplot)
        
        # HCIplot
        
        ``HCIplot`` -- High-contrast Imaging Plotting library. The goal of this
        library is to be the "Swiss army" solution for plotting and visualizing 
        multi-dimensional high-contrast imaging datacubes on ``JupyterLab``. 
        While visualizing FITS files is straightforward with SaoImage DS9 or any
        other FITS viewer, exploring the content of an HCI datacube as an 
        in-memory ``numpy`` array (for example when running your ``Jupyter`` 
        session on a remote machine) is far from easy. 
        
        ``HCIplot`` contains two functions, ``plot_frames`` and ``plot_cubes``,
        and relies on the ``matplotlib`` and ``HoloViews`` libraries and 
        ``ImageMagick``. ``HCIplot`` allows to:
        
        * Plot a single frame (2d array) or create a mosaic of frames.
        
        ![mosaic](https://github.com/carlgogo/carlgogo.github.io/blob/master/assets/images/hciplot.png?raw=true)
          
        * Annotate and save publication ready frames/mosaics.
        
        * Visualize 2d arrays as surface plots.
        
        * Create interactive plots when handling 3d or 4d arrays (thanks to 
        ``HoloViews``)
        
        ![datacube](https://github.com/carlgogo/carlgogo.github.io/blob/master/assets/images/hciplot2.png?raw=true)
        
        * Save to disk a 3d array as an animation (gif or mp4).
        
        
        ## Installation
        
        You can install ``HCIplot`` with ``pip``:
        
        ```
        pip install hciplot
        ```
        
        ``JupyterLab`` can be installed either with ``pip`` or with ``conda``:
        
        ```
        conda install -c conda-forge jupyterlab
        ```
        
        The ``PyViz`` extension must be installed to display the ``holoviews`` 
        widgets on ``JupyterLab``:
        
        ```    
        jupyter labextension install @pyviz/jupyterlab_pyviz
        ```
        
        If you want to create animations with ``plot_cubes`` you need to install
        ``ImageMagick`` with your system's package manager (e.g. brew if you are 
        on MacOS or apt-get if you are on Ubuntu). 
Keywords: plotting,hci,package
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: Astronomy
Description-Content-Type: text/markdown
