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

**ccdtools** can be installed using PyPI or conda, or by cloning the repository directly from GitHub. Below are instructions for each method.

Installing via PyPI
------------------
You can install **ccdtools** using PyPI, the Python package manager.
The latest **ccdtools** release can be found on PyPI here: https://pypi.org/project/ccdtools/

To install **ccdtools** using PyPI, run the following command in your terminal:

.. code-block:: bash

   pip install ccdtools

Installing via conda
--------------------
**ccdtools** can be installed using conda via the `accessnri` channel:  
https://anaconda.org/channels/accessnri/packages/ccdtools

.. code-block:: bash

   conda install accessnri::ccdtools

Installing from GitHub (development version)
--------------------------------------------
You can also install the latest development version of **ccdtools** directly from the GitHub repository:

1. Clone the repository:

   .. code-block:: bash

      git clone https://github.com/ACCESS-NRI/ccdtools.git

2. Navigate to the cloned directory:

   .. code-block:: bash

      cd ccdtools

3. Install local clone of **ccdtools** using `pip`:

   .. code-block:: bash

      pip install .

.. note::
   Installing from GitHub is recommended only if you want the latest features or are contributing to **ccdtools** development.

Using and verifying the installation
--------------------------
After installation is complete, **ccdtools** should be available for use in your chosen Python environment.

To use **ccdtools**, import the library into a workflow and check the installed version, run the following:

.. code-block:: python

   import ccdtools
   print(ccdtools.__version__)