Skip to content

kmedian/nptweak

Repository files navigation

Build Status Binder Gitpod - Code Now

nptweak

Utility functions for numpy. The only dependency is numpy.

Table of Contents

Installation

The nptweak git repo is available as PyPi package

pip install nptweak

Usage

Check the examples folder for notebooks.

Commands

Install a virtual environment

python3 -m venv .venv
source .venv/bin/activate
pip3 install --upgrade pip
pip3 install -r requirements.txt
pip3 install jupyterlab twine

(If your git repo is stored in a folder with whitespaces, then don't use the subfolder .venv. Use an absolute path without whitespaces.)

Python commands

  • Jupyter for the examples: jupyter lab
  • Check syntax: flake8 --ignore=F401 --exclude=$(grep -v '^#' .gitignore | xargs | sed -e 's/ /,/g')
  • Run Unit Tests: pytest
  • Upload to PyPi with twine: python setup.py sdist && twine upload -r pypi dist/*

Clean up

find . -type f -name "*.pyc" | xargs rm
find . -type d -name "__pycache__" | xargs rm -r
rm -r .pytest_cache
rm -r .venv

Debugging

  • Notebooks to profile python code are in the profile folder

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

About

utility functions for numpy

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages