initial commit

.gitignore

@@ -0,0 +1,276 @@
+
+# -- Project gitignore -----------------------------------------------------------------
+
+
+# setuptools_scm version file
+#  Use this if the project uses pyproject.toml with setuptools_scm instead of setup.py
+*/_version.py
+
+
+# -- Python gitignore ------------------------------------------------------------------
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+
+# -- LaTeX gitignore -------------------------------------------------------------------
+
+# LaTeX temporary files
+*.aux
+*.log
+*.toc
+
+# PDF output - usually a bad idea to keep this in Git
+*.pdf
+
+# Latexmk
+*.fdb_latexmk
+
+# SyncTeX
+*.synctex.gz
+
+# LaTeX Beamer
+*.snm
+*.vrb
+*.nav
+*.out
+
+# BibTeX
+*.bbl
+*.blg
+
+
+# -- Sublime gitignore -----------------------------------------------------------------
+
+# Sublime Text Project Files (usually contain absolute paths)
+*.sublime-project
+*.sublime-workspace
+
+
+# -- JetBrains gitignore ---------------------------------------------------------------
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion,
+# Android Studio, WebStorm and Rider
+# Source: https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+
+# JetBrains project folder
+.idea/
+
+# Uncomment for JetBrains specific template instead of ignoring all of .idea/
+## User-specific stuff
+#.idea/**/workspace.xml
+#.idea/**/tasks.xml
+#.idea/**/usage.statistics.xml
+#.idea/**/dictionaries
+#.idea/**/shelf
+#
+## AWS User-specific
+#.idea/**/aws.xml
+#
+## Generated files
+#.idea/**/contentModel.xml
+#
+## Sensitive or high-churn files
+#.idea/**/dataSources/
+#.idea/**/dataSources.ids
+#.idea/**/dataSources.local.xml
+#.idea/**/sqlDataSources.xml
+#.idea/**/dynamic.xml
+#.idea/**/uiDesigner.xml
+#.idea/**/dbnavigator.xml
+#
+## Gradle
+#.idea/**/gradle.xml
+#.idea/**/libraries
+#
+## Gradle and Maven with auto-import
+## When using Gradle or Maven with auto-import, you should exclude module files,
+## since they will be recreated, and may cause churn.  Uncomment if using
+## auto-import.
+## .idea/artifacts
+## .idea/compiler.xml
+## .idea/jarRepositories.xml
+## .idea/modules.xml
+## .idea/*.iml
+## .idea/modules
+## *.iml
+## *.ipr
+#
+## CMake
+#cmake-build-*/
+#
+## Mongo Explorer plugin
+#.idea/**/mongoSettings.xml
+#
+## File-based project format
+#*.iws
+#
+## IntelliJ
+#out/
+#
+## mpeltonen/sbt-idea plugin
+#.idea_modules/
+#
+## JIRA plugin
+#atlassian-ide-plugin.xml
+#
+## Cursive Clojure plugin
+#.idea/replstate.xml
+#
+## SonarLint plugin
+#.idea/sonarlint/
+#
+## Crashlytics plugin (for Android Studio and IntelliJ)
+#com_crashlytics_export_strings.xml
+#crashlytics.properties
+#crashlytics-build.properties
+#fabric.properties
+#
+## Editor-based Rest Client
+#.idea/httpRequests
+#
+## Android studio 3.1+ serialized cache file
+#.idea/caches/build_file_checksums.ser

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.2.0
+      hooks:
+          - id: end-of-file-fixer
+          - id: trailing-whitespace
+          - id: mixed-line-ending
+          - id: check-json
+          - id: check-yaml
+          - id: check-toml
+
+    - repo: https://github.com/psf/black
+      rev: 22.3.0
+      hooks:
+        - id: black
+          args: [ --safe ]
+
+    - repo: https://github.com/PyCQA/flake8
+      rev: 4.0.1
+      hooks:
+          - id: flake8
+            args: [--config, setup.cfg]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Dylan Jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# Matplotlib styles for scientific computing
+
+
+## Installation
+
+Install from GitHub via
+```commandline
+pip install git+https://github.com/dylanljones/mplstyles.git@VERSION
+```
+where `VERSION` is a release, tag or branch name.
+
+## Introduction
+
+Matplotlib allows you to customize the properties and default styles of plots.  
+There are three ways to customize Matplotlib (see [mplstyle] for more information):
+- [Setting rcParams at runtime](https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-dynamic-rc-settings)
+- [Using style sheets](https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-style-sheets)
+- [Changing your matplotlibrc file](https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files)
+
+> **Note**: Setting rcParams at runtime takes precedence over style sheets, 
+> style sheets take precedence over ``matplotlibrc`` files.
+
+This project uses the third option and is intended as a collection of usefull 
+matplotlibrc style files for scientific plotting.
+
+Hint: If you are using PyCharm to edit the ``*.mplstyle`` files, right-click on the file 
+and click 'Override File Type'. There, choose the ``Ini`` file-type. This enables
+some synthax highlighting, whcich makes it easier to find enables sections.
+
+## Usage
+
+The rc-files are contained in the ``mplstyles`` package. In general, any matplotlibrc file
+can be loaded via
+````python
+import matplotlib.pyplot as plt
+
+plt.style.use("file.mplstyle")
+````
+
+The included styles of ``mplstyles`` can be applied with the ``use_mplstyle`` method:
+````python
+from mplstyles import use_mplstyle
+
+use_mplstyle("figures")
+````
+
+A list of all included style files can be printed like this:
+````python
+from mplstyles import get_mplstyles
+
+print(get_mplstyles())
+````
+
+## Examples
+
+### ``figures.mplstyle``
+
+
+### ``plots.mplstyle``
+
+
+[mplstyle]: https://matplotlib.org/stable/tutorials/introductory/customizing.html