diff --git a/.gitignore b/.gitignore index ba52e69..6aa9f8b 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,164 @@ dev/ TODO.md new-version.md + +# 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/ +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: +*.log +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 + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__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/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/SciencePlots/__init__.py b/SciencePlots/__init__.py new file mode 100644 index 0000000..2275285 --- /dev/null +++ b/SciencePlots/__init__.py @@ -0,0 +1,19 @@ +from os import listdir +from os.path import isdir, join + +import matplotlib.pyplot as plt + +import pkg_resources + +# register the included stylesheet in the matplotlib style library +# TODO: migrate to importlib_resources when possible +data_path = pkg_resources.resource_filename('scienceplots', 'styles/') +stylesheets = plt.style.core.read_style_directory(data_path) # Reads styles in /styles +# Reads styles in /styles subfolders +for inode in listdir(data_path): + new_data_path = join(data_path, inode) + if isdir(new_data_path): + new_stylesheets = plt.style.core.read_style_directory(new_data_path) + stylesheets.update(new_stylesheets) +# Update dictionary of styles +plt.style.core.update_nested_dict(plt.style.library, stylesheets) diff --git a/styles/color/bright.mplstyle b/SciencePlots/styles/color/bright.mplstyle similarity index 100% rename from styles/color/bright.mplstyle rename to SciencePlots/styles/color/bright.mplstyle diff --git a/styles/color/high-contrast.mplstyle b/SciencePlots/styles/color/high-contrast.mplstyle similarity index 100% rename from styles/color/high-contrast.mplstyle rename to SciencePlots/styles/color/high-contrast.mplstyle diff --git a/styles/color/high-vis.mplstyle b/SciencePlots/styles/color/high-vis.mplstyle similarity index 100% rename from styles/color/high-vis.mplstyle rename to SciencePlots/styles/color/high-vis.mplstyle diff --git a/styles/color/light.mplstyle b/SciencePlots/styles/color/light.mplstyle similarity index 100% rename from styles/color/light.mplstyle rename to SciencePlots/styles/color/light.mplstyle diff --git a/styles/color/muted.mplstyle b/SciencePlots/styles/color/muted.mplstyle similarity index 100% rename from styles/color/muted.mplstyle rename to SciencePlots/styles/color/muted.mplstyle diff --git a/styles/color/retro.mplstyle b/SciencePlots/styles/color/retro.mplstyle similarity index 100% rename from styles/color/retro.mplstyle rename to SciencePlots/styles/color/retro.mplstyle diff --git a/styles/color/std-colors.mplstyle b/SciencePlots/styles/color/std-colors.mplstyle similarity index 100% rename from styles/color/std-colors.mplstyle rename to SciencePlots/styles/color/std-colors.mplstyle diff --git a/styles/color/vibrant.mplstyle b/SciencePlots/styles/color/vibrant.mplstyle similarity index 100% rename from styles/color/vibrant.mplstyle rename to SciencePlots/styles/color/vibrant.mplstyle diff --git a/styles/journals/ieee.mplstyle b/SciencePlots/styles/journals/ieee.mplstyle similarity index 100% rename from styles/journals/ieee.mplstyle rename to SciencePlots/styles/journals/ieee.mplstyle diff --git a/styles/journals/nature.mplstyle b/SciencePlots/styles/journals/nature.mplstyle similarity index 100% rename from styles/journals/nature.mplstyle rename to SciencePlots/styles/journals/nature.mplstyle diff --git a/styles/misc/cjk-jp-font.mplstyle b/SciencePlots/styles/misc/cjk-jp-font.mplstyle similarity index 100% rename from styles/misc/cjk-jp-font.mplstyle rename to SciencePlots/styles/misc/cjk-jp-font.mplstyle diff --git a/styles/misc/cjk-kr-font.mplstyle b/SciencePlots/styles/misc/cjk-kr-font.mplstyle similarity index 100% rename from styles/misc/cjk-kr-font.mplstyle rename to SciencePlots/styles/misc/cjk-kr-font.mplstyle diff --git a/styles/misc/cjk-sc-font.mplstyle b/SciencePlots/styles/misc/cjk-sc-font.mplstyle similarity index 100% rename from styles/misc/cjk-sc-font.mplstyle rename to SciencePlots/styles/misc/cjk-sc-font.mplstyle diff --git a/styles/misc/cjk-tc-font.mplstyle b/SciencePlots/styles/misc/cjk-tc-font.mplstyle similarity index 100% rename from styles/misc/cjk-tc-font.mplstyle rename to SciencePlots/styles/misc/cjk-tc-font.mplstyle diff --git a/styles/misc/grid.mplstyle b/SciencePlots/styles/misc/grid.mplstyle similarity index 100% rename from styles/misc/grid.mplstyle rename to SciencePlots/styles/misc/grid.mplstyle diff --git a/styles/misc/latex-sans.mplstyle b/SciencePlots/styles/misc/latex-sans.mplstyle similarity index 100% rename from styles/misc/latex-sans.mplstyle rename to SciencePlots/styles/misc/latex-sans.mplstyle diff --git a/styles/misc/no-latex.mplstyle b/SciencePlots/styles/misc/no-latex.mplstyle similarity index 100% rename from styles/misc/no-latex.mplstyle rename to SciencePlots/styles/misc/no-latex.mplstyle diff --git a/styles/misc/pgf.mplstyle b/SciencePlots/styles/misc/pgf.mplstyle similarity index 100% rename from styles/misc/pgf.mplstyle rename to SciencePlots/styles/misc/pgf.mplstyle diff --git a/styles/misc/russian-font.mplstyle b/SciencePlots/styles/misc/russian-font.mplstyle similarity index 100% rename from styles/misc/russian-font.mplstyle rename to SciencePlots/styles/misc/russian-font.mplstyle diff --git a/styles/misc/sans.mplstyle b/SciencePlots/styles/misc/sans.mplstyle similarity index 100% rename from styles/misc/sans.mplstyle rename to SciencePlots/styles/misc/sans.mplstyle diff --git a/styles/notebook.mplstyle b/SciencePlots/styles/notebook.mplstyle similarity index 100% rename from styles/notebook.mplstyle rename to SciencePlots/styles/notebook.mplstyle diff --git a/styles/scatter.mplstyle b/SciencePlots/styles/scatter.mplstyle similarity index 100% rename from styles/scatter.mplstyle rename to SciencePlots/styles/scatter.mplstyle diff --git a/styles/science.mplstyle b/SciencePlots/styles/science.mplstyle similarity index 100% rename from styles/science.mplstyle rename to SciencePlots/styles/science.mplstyle diff --git a/examples/plot-examples.py b/examples/plot-examples.py index 408ab85..63ade38 100644 --- a/examples/plot-examples.py +++ b/examples/plot-examples.py @@ -2,7 +2,7 @@ import numpy as np import matplotlib.pyplot as plt - +import scienceplots def model(x, p): return x ** (2 * p + 1) / (1 + x ** (2 * p)) diff --git a/setup.py b/setup.py index a5a6dca..b3b3cdf 100644 --- a/setup.py +++ b/setup.py @@ -1,43 +1,48 @@ """Install SciencePlots. -This script (setup.py) will copy the matplotlib styles (*.mplstyle) into the -appropriate directory on your computer (OS dependent). - -This code is based on a StackOverflow answer: -https://stackoverflow.com/questions/31559225/how-to-ship-or-distribute-a-matplotlib-stylesheet - +This script (setup.py) will install the SciencePlots package. +In order to expose .mplstyle files to matplotlib, "import scienceplots" +must be called before plt.style.use(...). """ -import atexit -import glob +# Commented out code is due to how installation was made. +# That code is based on a StackOverflow answer: +# https://stackoverflow.com/questions/31559225/how-to-ship-or-distribute-a-matplotlib-stylesheet +# It will remain here until a decision is made on if we should uninstall old versions or just ignore the issue. + +# import atexit +# import glob import os -import shutil +# import shutil -import matplotlib +# import matplotlib from setuptools import setup -from setuptools.command.install import install +# from setuptools.command.install import install + + +# def install_styles(): +# # Find all style files +# stylefiles = glob.glob('styles/**/*.mplstyle', recursive=True) +# # Find stylelib directory (where the *.mplstyle files go) +# mpl_stylelib_dir = os.path.join(matplotlib.get_configdir(), "stylelib") +# if not os.path.exists(mpl_stylelib_dir): +# os.makedirs(mpl_stylelib_dir) +# # Copy files over +# print("Installing styles into", mpl_stylelib_dir) +# for stylefile in stylefiles: +# print(os.path.basename(stylefile)) +# shutil.copy( +# stylefile, +# os.path.join(mpl_stylelib_dir, os.path.basename(stylefile))) -def install_styles(): - # Find all style files - stylefiles = glob.glob('styles/**/*.mplstyle', recursive=True) - # Find stylelib directory (where the *.mplstyle files go) - mpl_stylelib_dir = os.path.join(matplotlib.get_configdir(), "stylelib") - if not os.path.exists(mpl_stylelib_dir): - os.makedirs(mpl_stylelib_dir) - # Copy files over - print("Installing styles into", mpl_stylelib_dir) - for stylefile in stylefiles: - print(os.path.basename(stylefile)) - shutil.copy( - stylefile, - os.path.join(mpl_stylelib_dir, os.path.basename(stylefile))) +# ('notebook.mplstyle', 'scatter.mplstyle', 'science.mplstyle', 'bright.mplstyle', 'high-contrast.mplstyle', 'high-vis.mplstyle', 'light.mplstyle', 'muted.mplstyle', 'retro.mplstyle', 'std-colors.mplstyle', 'vibrant.mplstyle', 'ieee.mplstyle', 'nature.mplstyle', 'cjk-jp-font.mplstyle', 'cjk-kr-font.mplstyle', 'cjk-sc-font.mplstyle', 'cjk-tc-font.mplstyle', 'grid.mplstyle', 'latex-sans.mplstyle', 'no-latex.mplstyle', 'pgf.mplstyle', 'russian-font.mplstyle', 'sans.mplstyle') -class PostInstallMoveFile(install): - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - atexit.register(install_styles) +# class PostInstallMoveFile(install): +# def __init__(self, *args, **kwargs): +# super().__init__(*args, **kwargs) +# atexit.register(install_styles) # Get description from README @@ -54,6 +59,19 @@ def __init__(self, *args, **kwargs): long_description=long_description, long_description_content_type='text/markdown', license="MIT", + url="https://github.com/garrettj403/SciencePlots/", + + install_requires=['matplotlib'], + packages=["scienceplots"], + package_data={ + 'scienceplots': ['styles/**/*.mplstyle'], + }, + + classifiers=[ + 'Framework :: Matplotlib', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3' + ], keywords=[ "matplotlib-style-sheets", "matplotlib-figures", @@ -62,7 +80,5 @@ def __init__(self, *args, **kwargs): "matplotlib-styles", "python" ], - url="https://github.com/garrettj403/SciencePlots/", - install_requires=['matplotlib', ], - cmdclass={'install': PostInstallMoveFile, }, + # cmdclass={'install': PostInstallMoveFile, }, )