Metadata-Version: 2.4
Name: binmod1d
Version: 1.0.6
Summary: A 1D Column bin microphysics model that performs collision-coalescence and breakup.
Author-email: "Edwin Lee Dunnavan, RSII Cooperative Institute for Severe and High-Impact Research and Weather Operations (CIWRO)" <edwin.dunnavan@noaa.gov>
License: MIT
Project-URL: Homepage, https://github.com/NOAA-National-Severe-Storms-Laboratory/BinMod1D-PARS
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.2.6
Requires-Dist: mpmath>=1.3.0
Requires-Dist: scipy>=1.15.3
Requires-Dist: numba>=0.61.2
Requires-Dist: matplotlib>=3.10.3
Requires-Dist: netcdf4>=1.7.2
Requires-Dist: tqdm>=4.67.1
Requires-Dist: cloudpickle>=3.1.1
Provides-Extra: docs
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Dynamic: license-file

![BinMod1D Banner](https://raw.githubusercontent.com/NOAA-National-Severe-Storms-Laboratory/BinMod1D-PARS/main/assets/PyPi_Banner.png)
=======
# BinMod1D-PARS

[![Documentation Status](https://readthedocs.org/projects/binmod1d-pars/badge/?version=latest)](https://binmod1d-pars.readthedocs.io/en/latest/?badge=latest)

## 📖 Documentation

The full documentation for **BinMod1D-PARS** is available at [Read the Docs](https://binmod1d-pars.readthedocs.io/).

### Key Resources
* [**Introduction**](https://binmod1d-pars.readthedocs.io/en/latest/introduction.html) – Overview of the python package.
* [**Installation**](https://binmod1d-pars.readthedocs.io/en/latest/installation.html) – Quick start guide for local setup.
* [**Tutorial**](https://binmod1d-pars.readthedocs.io/en/latest/tutorials.html) – Quick start guide for using the **BinMod1D**
* [**Example Gallery**](https://binmod1d-pars.readthedocs.io/en/latest/examples.html) – Pre-configured notebooks that highlight the capabilities of **BinMod1D**.

---

This repository contains the BinMod1D python code. This is a python-based 1D bin (spectral) microphysical model designed to explicitly simulate collision-coalescence and collisional breakup. In order to use the code:

1.) Initialize the spectral model using the spectral_1d class: 

```python
from binmod1d.spectral_model import spectral_1d

s1 = spectral_1D()
```

The inputs to this class will specify the initial gamma particle size distribution (PSD), the bin resolution (sbin) and number of bins used (bins), as well as other parameters that determine how the model will be run.

2.) Use the spectral_1D.run() method to run the model with the inputs specified in spectral_1D()

```python
s1.run()
```

Various methods are included in the spectral_1d.py class that allow for easy plotting of bin model results.

