featherplot

Developer Guide

Setup

# create conda environment
$ mamba env create -f env.yml

# update conda environment
$ mamba env update -n featherplot --file env.yml
# $ mamba env update -n featherplot --file env.mac.yml

Install

pip install -e .

# install from pypi
pip install featherplot

nbdev

# activate conda environment
$ conda activate featherplot

# make sure the featherplot package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to the featherplot package
$ nbdev_prepare

Publishing

# publish to pypi
$ nbdev_pypi

# publish to conda
$ nbdev_conda --build_args '-c conda-forge'  --mambabuild

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/dsm-72/featherplot-py.git

or from conda

$ conda install -c dsm-72 featherplot

or from pypi

$ pip install featherplot