Metadata-Version: 2.1
Name: pyanthem
Version: 0.71
Summary: pyanthem - a neuroimaging audiovisualiation tool.
Home-page: https://github.com/nicthib/pyanthem
Author: Nic Thibodeaux
Author-email: dnt2111@columbia.edu
License: UNKNOWN
Description: ***********************************************************************
        pyanthem: an audiovisualization tool to make your data more interesting
        ***********************************************************************
        
        pyanthem is a Python_ tool that transforms three-dimensional time-varying datasets into a colorful, audible format. pyanthem boasts a variety of features: 
        
        1) Raw data decomposition
        2) Video and audio preview
        3) A broad variety of video and audio parameters
        4) Command-line reproduction via config files
        
        Requirements
        ============
        Python 3:
           Currently, pyanthem is tested to work on Python_ 3.7+. This will be 
           updated as more versions are tested.
        
        pip:
           pip is needed for the installation of the pyanthem module and its
           dependencies.  Most python versions will have pip installed already, 
           see the  `pip installation`_ page for instructions if you do not 
           have pip.
        
        ffmpeg:
           ffmpeg_ enables video creation and merging.
        
        fluidsynth (optional, but **highly recommended**)
           fluidsynth_ is a powerful software synthesizer, which enables 
           conversion of data to crisp, high quality sound files.
        
        git (optional):
          git_ allows pyanthem to download external audio files quickly and 
          easily.
          
        .. _Python: https://www.python.org/
        .. _`pip installation`: https://pip.pypa.io/en/latest/installing/
        .. _git: https://git-scm.com/
        .. _ffmpeg: https://ffmpeg.org/
        .. _fluidsynth: http://www.fluidsynth.org/
        
        Installation
        ============
        Note: If you do not have working versions of the above listed 
        requirements, it is recommended that you use miniconda_ or Anaconda_ for a
        straightforward installation process.
        
        Using Miniconda/Anaconda:
        ----------------
        
        First, download the `pyanthem.yaml`_ config file. 
        Create the environment by navigating to the pyanthem.yaml file's location, 
        and then by running::
        
           conda env create -f pyanthem.yaml
        
        Next, activate the environment::
        
           conda activate pyanthem
           
        Using pip
        ---------
        
        If you already have the requirements installed, install pyanthem using pip::
        
           python -m pip install pyanthem
        
        .. _miniconda: https://docs.conda.io/en/latest/miniconda.html
        .. _Anaconda: https://www.anaconda.com/products/individual
        .. _`pyanthem.yaml`: https://drive.google.com/file/d/1N7TB3Fypdwr8Aw1dQDSjyxit5Y-0mLZs
        .. _here: https://github.com/nicthib/FluidSynth-Windows-Builds/archive/v1.zip
        
        Usage
        =====
        
        Under construction!
        -------------------
        
        Team
        ====
        
        .. |niclogo| image:: https://avatars1.githubusercontent.com/u/34455769?v=3&s=200
        
        .. csv-table::
           :header: Nic Thibodeaux
        
           |niclogo|
            `<http://github.com/nicthib>`
        
        FAQ
        ===
        
        - **How do I do *specifically* so and so?**
            - No problem! Just do this.
        
        Support
        =======
        
        - Twitter: `@nicthibs`_
        
        .. _`@nicthibs`: http://twitter.com/nicthibs
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
