Skip to content

Unmap data from a pseudocolor image, with or without knowing the colormap.

License

Notifications You must be signed in to change notification settings

scienxlab/unmap

Repository files navigation

unmap

Run tests Build docs PyPI version PyPI versions PyPI license

Unmap data from pseudocolor images, with knowledge of the colourmap (for now!).

Installation

You can install this package with pip:

pip install unmap

There are dev, test and docs options for installing dependencies for those purposes, eg pip install unmap[dev].

Documentation

Read the documentation, especially the examples.

Contributing

Take a look at CONTRIBUTING.md.

Testing

You can run the tests (requires pytest and pytest-cov) with

pytest

Building

This repo uses PEP 517-style packaging. Read more about this and about Python packaging in general.

Building the project requires build, so first:

pip install build

Then to build unmap locally:

python -m build

The builds both .tar.gz and .whl files, either of which you can install with pip.