Principia
===============

.. raw:: html

  <img src='http://grandcentral.apam.columbia.edu:5555/slacklatex/badge?type=build&project=software_develop'>
  <img src='http://grandcentral.apam.columbia.edu:5555/slacklatex/badge?type=coverage&project=software_develop'>

This is the tentative name of our software package that we will be releasing. 

.. _dev_mode:

Development mode installation guide
------------------------------------------

To install it in development mode allows one to use the code with realtime
modifications without having to do extra work to update the module somewhere
in the site-packages.

To obtain a copy of the code, check out the following repository

.. code-block:: bash

  git clone -b develop \
    ssh://$(whoami)@grandcentral.apam.columbia.edu:2000/home/cam1/git_repos/marianetti_software.git

If your username in on the grandcentral is different from the username on you current mathine, replace ``$(whoami)``
with the username on grandcentral.

And to install the code in development mode

.. code-block:: bash

  python setup.py link

And follow the instructions to update ``PATH`` and ``PYTHONPATH``.
In this mode everything is installed into the ``.pylib`` and ``.pybin``, at the root directory of the repository.

Otherwise a normal install::

  pip install --user .

would work (it is recommended to install in user local directory).