|RTD| |License| |Issues| |Version_RTD| |Version_Astropy| .. _MAIN_SEC: **************************************************** Cookiecutter Data Science Template docs - VC Edition **************************************************** .. _AUTHOR_SEC: ======== Author ======== - `Victor Calderon `_ (`victor.calderon@vanderbilt.edu `_) - Driven Data Team .. _DESCRIPTION_SEC: =========== Description =========== .. epigraph:: **A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.** -- Data Science Team Making your project **reproducible** is one of the key elements when doing research in pretty much any field, including Data Science. This package aims at making it easier to be transparent about what *steps* and *commands* are used when producing tangible results for a research project. In the following sections, I will provide instructions on how to to use this project tempalte, as well as how to make the most out of this template. This documentation is part of the repository `cookiecutter-data-science-vc `_, and has been adapated from the `Cookiecutter Data Science Project template `_ by `Driven Data `_ organization. .. _MAIN_SEC_CONTENTS: ======== Contents ======== .. toctree:: :maxdepth: 1 getting_started/getting_started commands project_organization .. ---------------------------------------------------------------------------- Project based on the `modified `_ version of the `cookiecutter data science project template `_. .. |Issues| image:: https://img.shields.io/github/issues/vcalderon2009/cookiecutter-data-science-vc.svg :alt: GitHub issues :target: https://github.com/vcalderon2009/cookiecutter-data-science-vc/issues .. |RTD| image:: https://readthedocs.org/projects/cookiecutter-data-science-vc/badge/?version=latest :target: https://cookiecutter-data-science-vc.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg :target: https://github.com/vcalderon2009/cookiecutter-data-science-vc/blob/master/LICENSE :alt: Project License .. |Version_RTD| image:: https://img.shields.io/badge/Version-RTD-orange.svg :target: http://test-cookieproj-rtd.rtfd.io/ :alt: Version RTD .. |Version_Astropy| image:: https://img.shields.io/badge/Version-Astropy-orange.svg :target: http://test-cookieproj-astropy.rtfd.io/ :alt: Version Astropy