Metadata-Version: 2.4
Name: cmpitool
Version: 1.2
Summary: cmpitool
Home-page: https://github.com/JanStreffing/cmpitool
Download-URL: https://github.com/JanStreffing/cmpitool/archive/refs/tags/v1.2.tar.gz
Author: Jan Streffing
Author-email: j.streffing1988@gmail.com
License: MIT license
Keywords: cmpitool
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
License-File: LICENCE
Requires-Dist: geopandas
Requires-Dist: matplotlib
Requires-Dist: netCDF4>=1.6.0
Requires-Dist: numpy
Requires-Dist: pandas>=1.0.0
Requires-Dist: pooch
Requires-Dist: regionmask
Requires-Dist: seaborn
Requires-Dist: tqdm
Requires-Dist: xarray
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

.. image:: https://readthedocs.org/projects/cmpitool/badge/?version=latest
    :target: https://cmpitool.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

Installation Guide for CMPITool
================================

Obtain Source Code
-------------------
Clone the CMPITool repository from GitHub:

.. code-block:: shell

    git clone https://github.com/JanStreffing/cmpitool/

Create Conda Environment
------------------------
Navigate into the CMPITool directory and create a Conda environment containing the necessary libraries using the provided environment.yaml file:

.. code-block:: shell

    cd cmpitool
    conda env create -f environment.yaml

Activate Conda Environment
--------------------------
Activate the newly created Conda environment named "cmpitool":

.. code-block:: shell

    conda activate cmpitool

Install in Editable Mode
-------------------------
Install CMPITool in editable mode using pip:

.. code-block:: shell

    pip install -e .

Once installation is complete, you can start using CMPITool. For more info that that, check out the documentation at https://cmpitool.readthedocs.io/


=======
History
=======

1.1.2 (2025-04-15)
------------------

* Fixed issue #27: Added explicit version constraint for netCDF4 dependency to ensure it's properly installed

1.1.1 (2025-04-15)
------------------

* Version bump for official release with all fixes

1.1.0 (2025-04-15)
------------------

* Added fixed biasmap plot limits option to enable consistent visualizations across model runs
* Updated documentation to reflect new feature

0.1.5 (2023-12-08)
------------------
* Test for conda installation
* Includes sphinx found on https://cmpitool.readthedocs.io/en/documentation/

0.1.1 (2022-12-08)
------------------

* Fixing a number of pip and conda package bugs

0.1.0 (2022-12-06)
------------------

* First pre-release on through github.
