# Climalysis: Your Toolkit for Climate Impact Analysis ☁️🌞
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/jake-casselman/climalysis/blob/main/LICENSE) [![codebeat badge](https://codebeat.co/badges/d65911fc-a11d-4ca2-a914-792df78cb420)](https://codebeat.co/projects/github-com-jake-casselman-climalysis-main) ![PyPI](https://img.shields.io/pypi/v/climalysis.svg) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8105734.svg)](https://doi.org/10.5281/zenodo.8105734)




Developed by an assortment of active and past climate researchers, Climalysis is more than just a project – it's your one-stop platform for comprehensive climate impact studies. 

**Our Mission:**

We aim to:
- Democratize climate research, bringing advanced tools and methods into the public sphere.
- Foster collaboration and accelerate climate-related discoveries.
- Involve everyone in the climate conversation - researchers, analysts, and enthusiasts alike.
- Promote open science, shared knowledge, and sustainability. 

**What We Offer:**

Explore our code, dive into complex climate data, learn with us, and contribute your insights. With Climalysis, we empower your journey into the climate secrets of our world.

---
Whether you're seeking advanced research tools, passionate about data analysis, or simply curious about climate impacts, Climalysis welcomes you to join us in driving towards a sustainable future. Explore, learn, contribute, and let's delve deeper into our world's climate together.

## Table of Contents

1. [Installation](#installation)
2. [Dependencies](#dependencies)
3. [Usage](#usage)
5. [Contributing](#contributing)
6. [License](#license)
7. [Contact](#contact)
8. [Acknowledgments](#acknowledgments)

## Installation

First, clone the repository:

```shell
git clone https://github.com/jake-casselman/climalysis.git
```

Next, navigate to the cloned repository and install the package:

```shell
cd climalysis
python setup.py install
```

Ensure you have Python 3.x installed on your system before installation.

## Dependencies

Climalysis requires the following Python packages:

- numpy==1.23.5
- scikit_learn==1.2.1
- scipy==1.9.3
- setuptools==67.8.0
- statsmodels==0.13.5
- xarray==2023.3.0

These packages can be installed using pip by running the following command in your terminal:

```bash
pip install -r requirements.txt


## Usage

After installation, you can import and use our package in your Python scripts:

```python
from climalysis import module1, module2
```

You can now access the functions/classes in these modules.

## Contributing

We warmly welcome contributions! Please see [here](CONTRIBUTING.md) for details on how to contribute.

## License

This project is licensed under the terms of the GNU General Public License. See [LICENSE](LICENSE) for more details.

## Contact

If you have any questions, feel free to reach out to us.

## Acknowledgments

We would like to express our gratitude to all contributors and users of Climalysis. Your support is greatly appreciated.
