Metadata-Version: 2.1
Name: sdss-marvin
Version: 2.7.2
Summary: Toolsuite for dealing with the MaNGA dataset
Home-page: https://github.com/sdss/marvin
Author: The Marvin Developers
Author-email: havok2063@hotmail.com
License: BSD 3-Clause License
Project-URL: Repository, https://github.com/sdss/marvin
Project-URL: Documentation, https://sdss-marvin.readthedocs.org
Keywords: astronomy,software,marvin,manga,MaNGA
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=2.7
Description-Content-Type: text/x-rst
Requires-Dist: sdsstools (<1.0,>=0.4)
Requires-Dist: sdss-tree (<4.0,>=3.1.0)
Requires-Dist: sdss-access (<3.0,>=2.0)
Requires-Dist: marvin-brain (<1.0,>=0.2)
Requires-Dist: marvin-sqlalchemy-boolean-search (<1.0,>=0.2)
Requires-Dist: marvin-wtforms-alchemy (<1.0,>=0.16.9)
Requires-Dist: astropy (<5.0,>=3.3)
Requires-Dist: fuzzywuzzy (<1.0,>=0.15.0)
Requires-Dist: python-Levenshtein (<1.0,>=0.12.0)
Requires-Dist: raven (<7.0,>=5.32.0)
Requires-Dist: packaging (<21.0,>=20.1)
Requires-Dist: yamlordereddictloader (<1.0,>=0.2.2)
Requires-Dist: scipy (<2.0,>=0.18.1)
Requires-Dist: pandas (<2.0,>=0.18.1)
Requires-Dist: matplotlib (<4.0,>=1.5.3)
Requires-Dist: webargs (<6.0,>=1.5.2)
Requires-Dist: Flask-JWT-Extended (<4.0,>=3.8.1)
Requires-Dist: dogpile.cache (<1.1,>=0.6.2)
Provides-Extra: db
Requires-Dist: pgpasslib (<2.0,>=1.1.0) ; extra == 'db'
Requires-Dist: psycopg2 (<3.0,>=2.6.2) ; extra == 'db'
Requires-Dist: Flask-Login (<1.0,>=0.4.1) ; extra == 'db'
Requires-Dist: sqlalchemy (<1.4,>=1.3) ; extra == 'db'
Provides-Extra: dev
Requires-Dist: Sphinx (<4.0,>=2.1.0) ; extra == 'dev'
Requires-Dist: sphinx-bootstrap-theme (<1.0,>=0.4.12) ; extra == 'dev'
Requires-Dist: sphinxcontrib-httpdomain (<2.0,>=1.5.0) ; extra == 'dev'
Requires-Dist: sphinx-issues (<2.0,>=1.0.0) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (<2.0,>=0.4.2) ; extra == 'dev'
Requires-Dist: nbsphinx (<1.0,>=0.3.5) ; extra == 'dev'
Requires-Dist: photutils (<2.0,>=0.7) ; extra == 'dev'
Requires-Dist: mpl-scatter-density (<1.0,>=0.4) ; extra == 'dev'
Requires-Dist: jupyter-client (<8.0,>=5.2.3) ; extra == 'dev'
Requires-Dist: ipykernel (<7.0,>5.0) ; extra == 'dev'
Requires-Dist: ipython (<8.0,>=7.9.0) ; extra == 'dev'
Requires-Dist: matplotlib (<4.0,>=3.1.1) ; extra == 'dev'
Requires-Dist: flake8 (<5.0,>=3.7.9) ; extra == 'dev'
Requires-Dist: doc8 (<1.0,>=0.8.0) ; extra == 'dev'
Requires-Dist: pytest (<7.0,>=5.2.2) ; extra == 'dev'
Requires-Dist: pytest-cov (<4.0,>=2.8.1) ; extra == 'dev'
Requires-Dist: pytest-sugar (<1.0,>=0.9.4) ; extra == 'dev'
Requires-Dist: pytest-remotedata (<1.0,>=0.3.2) ; extra == 'dev'
Requires-Dist: pytest-flask (<2.0,>=0.10.0) ; extra == 'dev'
Requires-Dist: pytest-xdist (<3.0,>=1.18.1) ; extra == 'dev'
Requires-Dist: pytest-timeout (<3.0,>=1.2.0) ; extra == 'dev'
Requires-Dist: isort (<6.0,>=4.3.21) ; extra == 'dev'
Requires-Dist: coveralls (<4.0,>=1.1) ; extra == 'dev'
Requires-Dist: codecov (<3.0,>=2.0.15) ; extra == 'dev'
Requires-Dist: coverage[toml] (<7.0,>=5.0) ; extra == 'dev'
Requires-Dist: ipdb (<1.0,>=0.12.3) ; extra == 'dev'
Requires-Dist: invoke (<2.0,>=1.3.0) ; extra == 'dev'
Requires-Dist: twine (<4.0,>=3.1.1) ; extra == 'dev'
Requires-Dist: wheel (<1.0,>=0.33.6) ; extra == 'dev'
Requires-Dist: psycopg2 (<3.0,>=2.6.2) ; extra == 'dev'
Requires-Dist: selenium (<5.0,>=3.3.1) ; extra == 'dev'
Requires-Dist: page-objects (<2.0,>=1.1.0) ; extra == 'dev'
Requires-Dist: decorator (<6.0,>=4.1.2) ; extra == 'dev'
Requires-Dist: pympler (<1.0,>=0.5) ; extra == 'dev'
Requires-Dist: msgpack (<1.0,>=0.5.4) ; extra == 'dev'
Requires-Dist: msgpack-numpy (<1.0,>=0.4.2) ; extra == 'dev'
Requires-Dist: Flask-Testing (<1.0,>=0.6.1) ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: Sphinx (<4.0,>=2.1.0) ; extra == 'docs'
Requires-Dist: sphinx-bootstrap-theme (<1.0,>=0.4.12) ; extra == 'docs'
Requires-Dist: sphinxcontrib-httpdomain (<2.0,>=1.5.0) ; extra == 'docs'
Requires-Dist: sphinx-issues (<2.0,>=1.0.0) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (<2.0,>=0.4.2) ; extra == 'docs'
Requires-Dist: nbsphinx (<1.0,>=0.3.5) ; extra == 'docs'
Requires-Dist: photutils (<2.0,>=0.7) ; extra == 'docs'
Requires-Dist: mpl-scatter-density (<1.0,>=0.4) ; extra == 'docs'
Requires-Dist: jupyter-client (<8.0,>=5.2.3) ; extra == 'docs'
Requires-Dist: ipykernel (<7.0,>5.0) ; extra == 'docs'
Provides-Extra: extra
Provides-Extra: web
Requires-Dist: blinker (<2.0,>=1.4) ; extra == 'web'
Requires-Dist: Flask-JSGlue (<1.0,>=0.3) ; extra == 'web'
Requires-Dist: Flask-FeatureFlags (<1.0,>=0.6) ; extra == 'web'
Requires-Dist: Flask-Compress (<2.0,>=1.4) ; extra == 'web'
Requires-Dist: Flask-Limiter (<2.0,>=0.9.4) ; extra == 'web'
Requires-Dist: flask-profiler (<2.0,>=1.0.1) ; extra == 'web'
Requires-Dist: Flask-Caching (<2.0,>=1.4.0) ; extra == 'web'
Requires-Dist: Flask-Login (<1.0,>=0.4.1) ; extra == 'web'
Requires-Dist: Flask-Cors (<4.0,>=3.0.8) ; extra == 'web'
Requires-Dist: Flask-Session (<1.0,>=0.3.1) ; extra == 'web'
Requires-Dist: redis (<4.0,>=3.3) ; extra == 'web'
Requires-Dist: validators (<1.0,>=0.10.3) ; extra == 'web'
Requires-Dist: intervals (<1.0,>=0.8.0) ; extra == 'web'

Marvin
======

Marvin is the ultimate tool to visualise and analyse MaNGA data. It is
developed and maintained by the MaNGA team.

|Build Package| |Coverage Status| |PyPI| |DOI| |astropy|
|readthedocs|

Installation
------------

To painlessly install Marvin:

::

    pip install sdss-marvin

If you would like to contribute to Marvin's development, you can clone
this git repo, and run pip install in editable mode which will install all the
dev dependencies:

::

    git clone https://github.com/sdss/marvin
    cd marvin
    pip install -e .[dev]

What is Marvin?
---------------

Marvin is a complete ecosystem designed for overcoming the challenge of
searching, accessing, and visualizing the MaNGA data. It consists of a
three-pronged approach of a web app, a python package, and an API. The
web app, Marvin-web, provides an easily accessible interface for
searching the MaNGA data and visual exploration of individual MaNGA
galaxies or of the entire sample. The python package, in particular
Marvin-tools, allows users to easily and efficiently interact with the
MaNGA data via local files, files retrieved from the `Science Archive
Server <https://sas.sdss.org>`__, or data directly grabbed from the
database. The tools come mainly in the form of convenience functions and
classes for interacting with the data. An additional tool is a powerful
query functionality that uses the API to query the MaNGA databases and
return the search results to your python session. Marvin-API is the
critical link that allows Marvin-tools and Marvin-web to interact with
the databases, which enables users to harness the statistical power of
the MaNGA data set.

Documentation
-------------

You can find the latest Marvin documentation
`here <http://sdss-marvin.readthedocs.io/en/latest/>`__.

Citation and Acknowledgements
-----------------------------

If you use Marvin for work/research presented in a publication (whether
directly, or as a dependency to another package), we ask that you cite
the `Marvin Software <https://zenodo.org/record/292632>`__ (BibTeX). We
provide the following as a standard acknowledgment you can use if there
is not a specific place to cite the DOI:

::

    *This research made use of Marvin, a core Python package and web framework for MaNGA data, developed by Brian Cherinka, José Sánchez-Gallego, Brett Andrews, and Joel Brownstein. (MaNGA Collaboration, 2018).*

Marvin's Bibtex entry to use:

::

    @ARTICLE{2019AJ....158...74C,
           author = {{Cherinka}, Brian and {Andrews}, Brett H. and
             {S{\'a}nchez-Gallego}, Jos{\'e} and {Brownstein}, Joel and
             {Argudo-Fern{\'a}ndez}, Mar{\'\i}a and {Blanton}, Michael and
             {Bundy}, Kevin and {Jones}, Amy and {Masters}, Karen and
             {Law}, David R. and {Rowlands}, Kate and {Weijmans}, Anne-Marie and
             {Westfall}, Kyle and {Yan}, Renbin},
            title = "{Marvin: A Tool Kit for Streamlined Access and Visualization of the SDSS-IV MaNGA Data Set}",
          journal = {\aj},
         keywords = {astronomical databases: miscellaneous, methods: data analysis, surveys, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Astrophysics of Galaxies},
             year = 2019,
            month = aug,
           volume = {158},
           number = {2},
              eid = {74},
            pages = {74},
              doi = {10.3847/1538-3881/ab2634},
    archivePrefix = {arXiv},
           eprint = {1812.03833},
     primaryClass = {astro-ph.IM},
           adsurl = {https://ui.adsabs.harvard.edu/abs/2019AJ....158...74C},
          adsnote = {Provided by the SAO/NASA Astrophysics Data System}
    }



License
-------

Marvin is licensed under a 3-clause BSD style license - see the
``LICENSE.md`` file.

.. |Build Package| image:: https://github.com/sdss/marvin/actions/workflows/build.yml/badge.svg
   :target: https://github.com/sdss/marvin/actions/workflows/build.yml
.. |Coverage Status| image:: https://coveralls.io/repos/github/sdss/marvin/badge.svg?branch=master
   :target: https://coveralls.io/github/sdss/marvin?branch=master
.. |PyPI| image:: https://img.shields.io/pypi/v/sdss-marvin.svg
   :target: https://pypi.python.org/pypi/sdss-marvin
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.596700.svg
   :target: https://doi.org/10.5281/zenodo.596700
.. |astropy| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
   :target: http://www.astropy.org/
.. |readthedocs| image:: https://readthedocs.org/projects/docs/badge/
   :target: http://sdss-marvin.readthedocs.io/en/latest/


