Getting Started
===============

Getting involved
----------------

Please report **bugs** or **enhancement requests** through the `Issue
Tracker`_.

.. _Issue Tracker: https://github.com/cbc-univie/mdy-newanalysis/issues


User Guide
----------

xxx

.. _installation-instructions:

Installing newanalysis
----------------------

Source Code
^^^^^^^^^^^

It is recommended to use a (conda) environment for the installation. Go to `install using conda env`_.

**Source code** is available from
https://github.com/cbc-univie/mdy-newanalysis
Obtain the sources with `git`_.

.. code-block:: bash

   git clone https://github.com/cbc-univie/mdy-newanalysis.git
   cd mdy-newanalysis/src
   python setupy.py install

.. _git: https://git-scm.com/

.. _install using conda env:

Conda Environment
^^^^^^^^^^^^^^^^^

Information how to obtain conda can be found `here <https://docs.conda.io/projects/conda/en/latest/>`_.

First create a conda environment and install the dependencies. You can clone the github project and use the yml file. 


Citation
--------

When using newanalysis in published work, please cite 

- tba

Thank you!