Metadata-Version: 2.1
Name: myplotlib
Version: 1.0.0
Summary: `matplotlib` binder with custom styles and routines for fast plotting
Home-page: https://github.com/haykh/myplotlib
Author: morninbru
Author-email: haykh.astro@gmail.com
License: BSD 3-Clause License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# `myplotlib`

`matplotlib` binder with custom styles and routines for fast plotting. see [previews of available styles](myplotlib/previews).

### installation

```shell
pip install myplotlib
```

### usage

```python
# initialize style:
import myplotlib
myplotlib.load(style=..., flavor=...)
# style can be [`fancy` | `mono` | `hershey`]
# flavor can be [`light` | `dark`]
# if not specified defaults to `style = 'main', flavor = 'light'`

# auxiliary functions for plotting:
import myplotlib.plots as myplt
# type for docstring:
myplt?

# preview custom styles with built-in functions
import myplotlib.tests as mypltest
# type for docstring:
mypltest?
```

for more usage examples checkout the `tests/` submodule.

### requirements

* `python >= 3.6`
* `matplotlib >= 3.0.0`, `numpy`, `numba`
* `latex` (used for `style="fancy"` only)

### development

Building tarballs in the `dist` directory:

```sh
python -m build --sdist --outdir dist .
```

### Latest updates
* `1.0.0` [Dec 2022]
  - initial release to pypi
* `0.9.4r2` [Mar 2022]
  - better `hershey` font
  - fallback cursive font added
* `v0.9.4` [Mar 2022]
  - new `hershey` style a-la IDL
  - minor bug fixes in auto-determining the plot ranges
  - PEP 8 compatible style

### To-do

- [ ] isocontour plotting
- [x] add streamplot for fieldline plotting
- [x] print all the newly added colormaps and the default color sequence
- [x] add a test plot for the demo
- [x] add image to readme
- [x] dark mode
- [x] monotype non-Latex mode
