Getting started
===============

Installation
------------

To use the entropy library within Python, first extract it from its archive, and then move to the newly created directory and run the following two commands:

.. code-block:: console

   (.venv) $ ./configure
   (.venv) $ make python
   
This will install the entropy library to your current virtual environment (.venv)

Matlab Installation
-------------------

Although this documentation is aimed at the Python version, we mention here that the library can also be built for Matlab. 

.. code-block:: console

   (.venv) $ ./configure MATLAB=/Applications/MATLAB_R2023a.app
   (.venv) $ make matlab
   
This will not install anything, so you'll then have to add the ./bin/matlab directory to your matlab search path, or copy it to some place matlab will be able to find it.

Import
------

To import the main library from Python::

    import entropy.entropy as entropy # estimation functions
    
To import extra parts of the library, you can also add the following::

    import entropy.tools as tools     # tools for input formating and other tools
    import entropy.masks as masks     # tools for masking data
    
To see which functions are available in each part of the library, check the documentation.