Giter Club home page Giter Club logo

sandman's Introduction

sandman logo

build-docs action License: MIT CodeFactor Grade GitHub Repo stars

Full documentation is available here.

๐ŸŒˆ Project motivation

Making scientific data and visualizations accessible to as many people as possible is clearly an excellent goal. However, everyone has different aesthetic preferences, and sacrificing visual appeal for accessibility is not generally necessary. If you have found that you are unsatisfied or bored with existing perceptually uniform colormaps, this project may be what you need.

๐Ÿ”ฉ Building and installing

To build and install this package with pip, the same procedure can be followed as for most pure Python packages that use setuptools. In the install step, some optional flags are given below in brackets that can be useful for a non-root build (--user) or for active development (--ignore-installed --force-reinstall), but these are not strictly necessary to install the package itself.

pip3 install [--force-reinstall --ignore-installed] [--user] git+https://github.com/emprice/sandman.git@main

๐Ÿ’Ž Credits and dependencies

This package depends on several packages not in the Python standard library, including the following.

  • NumPy and SciPy are instrumental for optimizing colormaps and working with the numeric data efficiently.
  • colorspacious is used for modeling human vision perception.
  • webcolors is used for parsing hexadecimal color strings, which is currently the only recognized user-facing input format.

The command-line tool further relies on the following extra dependencies.

  • Matplotlib and Pillow are needed for previewing and simulating the colormaps.
  • pronounceable is used for generating random, but pronounceable, colormap names when maps are generated in bulk.

Finally, the following dependencies deserve special recognition for their use in the HTML documentation.

  • Furo is the base theme used in conjunction with Sphinx to build the documentation pages.
  • The Nord colorscheme is a beautiful set of color palettes with a frosty blue feel. The documentation colors and example colormaps are based on these colors.

sandman's People

Contributors

emprice avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.