.. highlight:: shell

============
Installation
============


Using pip
--------------

To install oceanum, run this command in your terminal:

.. code-block:: console

    $ pip install oceanum

This is the preferred method to install oceanum, as it will always install the most recent stable release. There is also a conda package which may work better on Windows installations:

.. code-block:: console

    $ conda install -c conda-forge oceanum

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for oceanum can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/oceanum/oceanum-python

Or download the `tarball`_:

.. code-block:: console

    $ curl  -OL https://github.com/oceanum/oceanum-python/tarball/master

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _Github repo: https://github.com/oceanum/oceanum-python
.. _tarball: https://github.com/oceanum/oceanum-python/tarball/master


SSL certificate errors on Windows
--------------------------------

If you get SSL certificate errors on Windows when using the library, you can install the 'pip-system-certs' package with the following command:

.. code-block:: console

    $ pip install pip-system-certs