StonerPlots 1.0.0__tar.gz

StonerPlots-1.0.0/.gitignore

@@ -0,0 +1,173 @@
+.ipynb_checkpoints/
+.DS_STORE
+SciencePlots.egg-info/
+
+dist/
+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/
+
+# Spyder Projects
+.spyderproject

StonerPlots-1.0.0/CHANGES.md

@@ -0,0 +1,8 @@
+v1.0.0 (developement)
+=====================
+
+Initial fork from scienceplots 2.1.1
+- Add aps plot style
+- Remove language styles
+- Add SavedFigures context manager
+- Use pathlib.Path and not os.path

StonerPlots-1.0.0/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Original scienceplots pacakge
+Copyright (c) 2018 John Garrett
+StonerPlots changes
+Copyright (c) 2024 Gavin Burnell
+
+
+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.

StonerPlots-1.0.0/MANIFEST.in

@@ -0,0 +1 @@
+global-include *.mplstyle

StonerPlots-1.0.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.1
+Name: StonerPlots
+Version: 1.0.0
+Summary: This is a fork of scienceplots and provides a range of matplotlib styles for plotting physics...
+Author-email: Gavin Burnell <G.Burnell@leeds.ac.uk>
+Project-URL: Homepage, https://github.com/stonerlab/stonerplots/
+Project-URL: Issues, https://github.com/stonerlab/stonerplots/issues
+Keywords: matplotlib-style-sheets,matplotlib-figures,scientific-papers,thesis-template,matplotlib-styles,python
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+Stoner Plots
+=============
+
+Stoner Plots is a fork of Science Plots
+
+*Matplotlib styles for physics figures*
+
+Usage
+-----
+
+Before using the new styles you need to import stonerplots - but it's ok to just import e.g. the SavedFigure context
+manager:
+
+    from stonerplots import SavedFigure
+
+    with SavedFigure("my_figure.pdf", style=["stoner","aps"]):
+        plt.figure()
+        plt.plot(x,y,label="Dataset")
+        ...
+
+The SavedFigure context manager will handle the call to the matplotlib style context manager and will also save any
+figures opened within the context manager. If the filename for the figure has an embedded place holder for {ix}, then
+multiple figures can be saved without clobbering the filename.
+
+There is also an InsetPlot context manager that can help you get insets placed correctly so that axes
+labels don't escape over the edge of the surrounding figure.
+
+    with SavedFigure("my_figure.pdf", style=["stoner","aps"]):
+        plt.figure()
+        plt.plot(x,y,label="Dataset")
+        ...
+        with InsetPlot(loc="lower right", width=0.25, height=0.25, padding=0.05) as inset:
+            inset.plot(x, model(x, 200), linestyle="--")
+
+
+Available Styles
+----------------
+
+ * stoner - this is the base style sheet
+ * poster - makes everything bigger for printing on a poster
+ * notebook - makes things a little bigger for a Jupyter notebook - from the original scienceplots package
+ * presentation - a style suitable for the main graph on a powerpoint slide
+ * presentation_sm - a style for making 1/2 width graphs.
+
+Journal Styles
+--------------
+
+ * nature - for Nature group journals - from the original scienceplots package
+ * ieee - for IEEE Transactions journals - from the original scienceplots package
+ * aps - for American Physical Society Journals (like Phys Rev Lett etc.)
+
+Modifiers
+---------
+
+ * aps1.5 - Switch to 1.5 column format
+ * aps2.0 - Switch to 2 column format
+
+Colour Cycles
+-------------
+
+The default colour cycle is based on the London Underground map colour scheme (why not?) and goes
+
+ * Northern
+ * Central
+ * Picadily
+ * District
+ * Metropolitan
+ * Bakerloo
+ * JUbilee
+ * Overground
+ * Victoria
+ * Elizabeth
+ * Circle
+
+
+This package draws heavily on scienceplots, so it seems only fair to cite the original work....
+
+    @article{StonerPlots,
+      author       = {John D. Garrett},
+      title        = {{garrettj403/SciencePlots}},
+      month        = sep,
+      year         = 2021,
+      publisher    = {Zenodo},
+      version      = {1.0.9},
+      doi          = {10.5281/zenodo.4106649},
+      url          = {http://doi.org/10.5281/zenodo.4106649}
+    }

StonerPlots-1.0.0/README.md

@@ -0,0 +1,87 @@
+Stoner Plots
+=============
+
+Stoner Plots is a fork of Science Plots
+
+*Matplotlib styles for physics figures*
+
+Usage
+-----
+
+Before using the new styles you need to import stonerplots - but it's ok to just import e.g. the SavedFigure context
+manager:
+
+    from stonerplots import SavedFigure
+
+    with SavedFigure("my_figure.pdf", style=["stoner","aps"]):
+        plt.figure()
+        plt.plot(x,y,label="Dataset")
+        ...
+
+The SavedFigure context manager will handle the call to the matplotlib style context manager and will also save any
+figures opened within the context manager. If the filename for the figure has an embedded place holder for {ix}, then
+multiple figures can be saved without clobbering the filename.
+
+There is also an InsetPlot context manager that can help you get insets placed correctly so that axes
+labels don't escape over the edge of the surrounding figure.
+
+    with SavedFigure("my_figure.pdf", style=["stoner","aps"]):
+        plt.figure()
+        plt.plot(x,y,label="Dataset")
+        ...
+        with InsetPlot(loc="lower right", width=0.25, height=0.25, padding=0.05) as inset:
+            inset.plot(x, model(x, 200), linestyle="--")
+
+
+Available Styles
+----------------
+
+ * stoner - this is the base style sheet
+ * poster - makes everything bigger for printing on a poster
+ * notebook - makes things a little bigger for a Jupyter notebook - from the original scienceplots package
+ * presentation - a style suitable for the main graph on a powerpoint slide
+ * presentation_sm - a style for making 1/2 width graphs.
+
+Journal Styles
+--------------
+
+ * nature - for Nature group journals - from the original scienceplots package
+ * ieee - for IEEE Transactions journals - from the original scienceplots package
+ * aps - for American Physical Society Journals (like Phys Rev Lett etc.)
+
+Modifiers
+---------
+
+ * aps1.5 - Switch to 1.5 column format
+ * aps2.0 - Switch to 2 column format
+
+Colour Cycles
+-------------
+
+The default colour cycle is based on the London Underground map colour scheme (why not?) and goes
+
+ * Northern
+ * Central
+ * Picadily
+ * District
+ * Metropolitan
+ * Bakerloo
+ * JUbilee
+ * Overground
+ * Victoria
+ * Elizabeth
+ * Circle
+
+
+This package draws heavily on scienceplots, so it seems only fair to cite the original work....
+
+    @article{StonerPlots,
+      author       = {John D. Garrett},
+      title        = {{garrettj403/SciencePlots}},
+      month        = sep,
+      year         = 2021,
+      publisher    = {Zenodo},
+      version      = {1.0.9},
+      doi          = {10.5281/zenodo.4106649},
+      url          = {http://doi.org/10.5281/zenodo.4106649}
+    }