Merge pull request #88 from likeness-pop/develop

prep `v2.2.8` - merge `develop` into `main`

Author: jGaboardi

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 files: "pymedm\/|notebooks\/"
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.14.14"
+    rev: "v0.15.0"
     hooks:
       - id: ruff-check
       - id: ruff-format

README.md

@@ -1,11 +1,70 @@
 # PyMEDM: Penalized Maximum-Entropy Dasymetric Modeling (P-MEDM) in Python
 
 ![tag](https://img.shields.io/github/v/release/likeness-pop/pymedm?include_prereleases&sort=semver)
+[![PyPI version](https://badge.fury.io/py/pymedm.svg)](https://badge.fury.io/py/pymedm)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/pymedm.svg)](https://anaconda.org/conda-forge/pymedm)
+
 [![Continuous Integration](https://github.com/likeness-pop/pymedm/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/likeness-pop/pymedm/actions/workflows/continuous_integration.yml)
 [![codecov](https://codecov.io/gh/likeness-pop/pymedm/branch/develop/graph/badge.svg)](https://codecov.io/gh/likeness-pop/pymedm)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
-This is a GPU-ready Python port of [PMEDMrcpp](https://bitbucket.org/jovtc/pmedmrcpp/src/master) via `jax` and `jaxopt`. 
+This is a GPU-ready Python port of [PMEDMrcpp](https://bitbucket.org/jovtc/pmedmrcpp/src/master) via `jax` and `jaxopt`. Support for usage on Windows is not guaranteed.
+
+## Installation
+
+### Conda-forge (recommended)
+
+The `pymedm` feedstock is available via the [conda-forge channel](https://github.com/conda-forge/pymedm-feedstock).
+
+```
+$ conda install --channel conda-forge pymedm
+```
+
+### PyPI
+
+`pymedm` is available on the [Python Package Index](https://pypi.org/project/pymedm/).
+
+```
+$ pip install pymedm
+```
+
+### Source
+
+#### Directly via GitHub + `pip`
+
+```
+$ pip install git+https://github.com/likeness-pop/pymedm.git@develop
+```
+
+#### Download + `pip`
+
+Download the source distribution (``.tar.gz``) and decompress where desired. From that location:
+
+```
+$ pip install .
+```
+
+## Usage
+
+* See usage examples in [`./notebooks/`](https://github.com/likeness-pop/pymedm/tree/main/notebooks)
+
+## Development
+
+1. Clone the repository to the desired location.
+2. Install in editable mode
+   * Navigate to where the repo was cloned locally.
+   * Within that directory:
+      ```
+      $ pip install -e .
+      ```
+3. Open an Issue for discussion
+4. In a branch off `develop`, implement update/bug fix/etc.
+5. Create a minimal Pull Request with clear description linked back to the associated issue from (3.)
+6. Wait for review from maintainers
+7. Adjust as directed
+8. Once merged, fetch down `origin/develop` and merge into the local `develop`
+9. Delete the branch created in (4.)
+10. Start over at (2.)
 
 ## References