Skip to main content

Toolsuite for dealing with the MaNGA dataset

Project description

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

[![Build Status](https://travis-ci.org/sdss/marvin.svg?branch=master)](https://travis-ci.org/sdss/marvin)
[![Coverage Status](https://coveralls.io/repos/github/sdss/marvin/badge.svg?branch=master)](https://coveralls.io/github/sdss/marvin?branch=master)
[![PyPI](https://img.shields.io/pypi/v/sdss-marvin.svg)](https://pypi.python.org/pypi/sdss-marvin)
[![PyPI download](https://img.shields.io/pypi/dm/sdss-marvin.svg)](https://pypi.python.org/pypi/sdss-marvin)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.292632.svg)](https://doi.org/10.5281/zenodo.292632)
[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=WWgyaGJBbW45aityUVJtYytDcHFydU9EZE9ObVdOVVpkaUxGZkxwbzdHQT0tLUNkcW5Hc3JaRTdqR0l6ajltSUdTRXc9PQ==--21b221b6714b852f8f4215c787ffa6e2812e2ad6)

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, pip install the dependencies, update the submodules, and then setup with `python setup.py install`:

git clone https://github.com/sdss/marvin
cd marvin
pip install -r requirements.txt
git submodule init
git submodule update
python setup.py install


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.

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, and Brett Andrews. (MaNGA Collaboration, 2016).*

Marvin's Bibtex entry to use:

@misc{brian_cherinka_2017_292632,
author = {Brian Cherinka and
José Sánchez-Gallego and
Brett Andrews},
title = {sdss/marvin: Marvin Beta 2.1.0},
month = feb,
year = 2017,
doi = {10.5281/zenodo.292632},
url = {https://doi.org/10.5281/zenodo.292632}
}

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sdss_marvin-2.1.3.dev0-py2-none-any.whl (9.6 MB) Copy SHA256 hash SHA256 Wheel py2
sdss_marvin-2.1.3.dev0-py3-none-any.whl (9.6 MB) Copy SHA256 hash SHA256 Wheel py3
sdss-marvin-2.1.3.dev0.tar.gz (333.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page