# Community guidelines¶

CMasher is an open-source and free-to-use software package (and it always will be), provided under the BSD-3 license given below.

Users are highly encouraged to make contributions to the package or request new features by opening a GitHub issue. As with contributions, if you find a problem or issue with CMasher, please do not hesitate to open a GitHub issue about it.

If you use CMasher for your work, then please star the repo, such that I can keep track of how many users it has and more easily raise awareness of bad colormaps. Additionally, if you use CMasher as part of your workflow in a scientific publication, please consider including an acknowledgement like “Parts of the results in this work make use of the colormaps in the CMasher package.” and citing the CMasher paper using the BibTeX-entry further below.

BSD 3-Clause License

Copyright (c) 2019-2020, Ellert van der Velden

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


## Citation¶

This BibTeX-entry is also available in CMasher using get_bibtex().

@ARTICLE{2020JOSS....5.2004V,
author = {{van der Velden}, Ellert},
title = "{CMasher: Scientific colormaps for making accessible, informative and 'cmashing' plots}",
journal = {The Journal of Open Source Software},
keywords = {Python, science, colormaps, data visualization, plotting,
Electrical Engineering and Systems Science - Image and Video Processing,
Physics - Data Analysis, Statistics and Probability},
year = 2020,
month = feb,
volume = {5},
number = {46},
eid = {2004},
pages = {2004},
doi = {10.21105/joss.02004},
archivePrefix = {arXiv},
eprint = {2003.01069},
primaryClass = {eess.IV},