StonerPlots 1.6.1__tar.gz

stonerplots-1.6.1/.github/workflows/build_conda.yaml

@@ -0,0 +1,54 @@
+
+name: Conda
+
+on:
+  release:
+    types: ['released', 'prereleased']
+
+# workflow_dispatch:        # Un comment line if you also want to trigger action manually
+defaults:
+  run:
+    shell: bash -l {0}
+jobs:
+  conda_deployment_with_new_tag:
+    name: Conda deployment of package for platform ${{ matrix.os }} with Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: ["3.10"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - name: Conda environment creation and activation
+        uses: conda-incubator/setup-miniconda@a4260408e20b96e80095f42ff7f1a15b27dd94ca
+        with:
+          python-version: ${{ matrix.python-version }}
+          environment-file: recipe/build-env.yml    # Path to the build conda environment
+          activate-environment: build-environment
+          auto-update-conda: true
+          auto-activate-base: false
+          show-channel-urls: true
+      - name: Set VERSION environment variable
+        run: |
+          export VERSION=`python setup.py --version`
+          echo "VERSION=$VERSION" >> "$GITHUB_ENV"
+      - name: Build and upload the conda packages
+        uses: uibcdf/action-build-and-upload-conda-packages@d72a2d950af55243bbc385185dd68b824211192d
+        with:
+          meta_yaml_dir: recipe
+          python-version: ${{ matrix.python-version }} # Values previously defined in `matrix`
+          user: phygbu
+          label: auto
+          overwrite: true
+          token: ${{ secrets.ANACONDA }} # Replace with the right name of your secret
+      - name: Build and upload wheel
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |
+         cd /home/runner/work/stonerplots/stonerplots
+         conda info
+         python -m build
+         twine upload dist/*

stonerplots-1.6.1/.github/workflows/publish_sphinx.yaml

@@ -0,0 +1,20 @@
+name: Build Docs
+
+on:
+  push:
+    branches: [main] # branch to trigger deployment
+
+jobs:
+  pages:
+    runs-on: ubuntu-20.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892
+      with:
+        documentation_path: ./docs/source

stonerplots-1.6.1/.github/workflows/pytest.yaml

@@ -0,0 +1,43 @@
+name: pytest
+
+on:
+  push:
+    branches: [main] # branch to trigger deployment
+
+# workflow_dispatch:        # Un comment line if you also want to trigger action manually
+defaults:
+  run:
+    shell: bash -l {0}
+jobs:
+  conda_deployment_with_new_tag:
+    name: Conda deployment of package for platform ${{ matrix.os }} with Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: ["3.10"]
+
+    steps:
+      - name: Setup TeX Live
+        run: sudo apt-get install -y texlive-latex-extra texlive-latex-recommended texlive-fonts-recommended cm-super dvipng
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - uses: mamba-org/setup-micromamba@617811f69075e3fd3ae68ca64220ad065877f246
+        with:
+          environment-name: myenv
+          create-args: >-
+            python=3.10
+            pytest
+            numpy
+            pytest-md
+            pytest-emoji
+            matplotlib
+      - name: Run pytest
+        uses: pavelzw/pytest-action@510c5e90c360a185039bea56ce8b3e7e51a16507
+        with:
+          verbose: true
+          emoji: true
+          job-summary: true
+          custom-arguments: '-q'
+          click-to-expand: true
+          report-title: 'Test Report'

stonerplots-1.6.1/.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.6.1/CHANGES.md

@@ -0,0 +1,71 @@
+# Changelog
+
+## v1.6.0 Release
+
+New features
+
+- Added the inset autolocator code.
+- Added a medium resolution style sheet.
+- PlotLabeller context manager to apply axes formatting to new figures.
+- Additional Formatting functions from the stoner Package.
+- Added a DoubleYAxis context manager for helping with double-y axis plots.
+
+## v1.5.2 Release
+
+Further code cleanups following codacy code quality checks.
+
+## v1.5.1 Release
+
+Some refactoring of the context managers and other code cleanups. No intentional changes to the API.
+
+## v1.5.0 Release
+
+Iregular grids in MultuPanel now can also do different numbers of rows in each column with the _transpose_ parameter.
+
+## v1.4.0 Release
+
+Iregullar grids in MultiPanel that support different numbers of plots in each row.
+
+## v1.3.2 Release
+
+Improve StackVertical to allow asymmetric stacked plots and make an example for plotting
+GenX fits.
+
+- Add AAAS-Science stylesheet with 2 and 3 column variants.
+- Improve SavedFigure to make it reusable and also adjustable after creation via call method.
+- Improvements to StackVertical and MultiPanel to do more calculations with plot transforms.
+
+## v1.3.1 Thesis Style
+
+Add a stylesheet that tries to match the CM Group's LaTeX thesis template.
+
+## v1.3.0 New MultiPanel Context Manager
+
+Add a context manager for making multipanel figures more easily.
+
+- MultiPanel Context Manger
+- Improve documentation some more
+
+## v1.2.0 New StackVertical Context Manager
+
+Add a context manager for producing vertically stacked plots in a constrained layout.
+
+- StackVertical added
+- Rework examples into separate scripts
+- Add Sphinx docs
+
+## v1.1.0 New Stylesheets
+
+Add New stylesheets to the package
+
+- Add IOP styles
+- Get package building running
+
+## 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.6.1/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.6.1/MANIFEST.in

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

stonerplots-1.6.1/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.2
+Name: StonerPlots
+Version: 1.6.1
+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
+
+[![GitHub version](https://badge.fury.io/gh/stonerlab%2Fstonerplots.svg)](https://badge.fury.io/gh/stonerlab%2Fstonerplots)
+[![pytest](https://github.com/stonerlab/stonerplots/actions/workflows/pytest.yaml/badge.svg)](https://github.com/stonerlab/stonerplots/actions/workflows/pytest.yaml)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/bc7404ac3cbf432184a13b6c3cb88ea4)](https://app.codacy.com/gh/stonerlab/stonerplots/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![PyPI version](https://badge.fury.io/py/StonerPlots.svg)](https://badge.fury.io/py/StonerPlots)
+[![Build Docs](https://github.com/stonerlab/stonerplots/actions/workflows/publish_sphinx.yaml/badge.svg)](https://stonerlab.github.io/stonerplots/)
+[![Conda](https://github.com/stonerlab/stonerplots/actions/workflows/build_conda.yaml/badge.svg)](https://github.com/stonerlab/stonerplots/actions/workflows/build_conda.yaml)
+[![Conda Version](https://anaconda.org/phygbu/stonerplots/badges/version.svg)](https://anaconda.org/phygbu/stonerplots)
+![Not platform specific](https://anaconda.org/phygbu/stonerplots/badges/platforms.svg)
+![MIT Licensed](https://anaconda.org/phygbu/stonerplots/badges/license.svg)
+[![DOI](https://zenodo.org/badge/776970304.svg)](https://zenodo.org/doi/10.5281/zenodo.10905673)
+
+# Stoner Plots
+
+Stoner Plots is a fork of Science Plots with additional features to make plotting of scientific plots easier.
+
+<img src="https://raw.githubusercontent.com/stonerlab/stonerplots/main/examples/figures/fig05a.png" width=640 alt="Presentation Style Image"/>
+
+## Usage
+
+Before using the new styles you need to import stonerplots - but you will most likely also want to make use of
+one of the context managers - the `SavedFigure` class.
+
+    from stonerplots import SavedFigure
+
+    with SavedFigure("my_figure.pdf", style=["stoner","aps"]):
+        plt.figure()
+        plt.plot(x,y,label="Dataset")
+        ...
+
+There are three main parts to this package::
+
+1. A set of matplotlib style sheets for making lots wih styles suitable for a variety of Physics related journals
+   and formats such as presentations and posters as well as reports and theses.
+
+1. A set of Python Content managers designed to help with the process of preparing production quality figures in
+  matplotlib.
+
+1. Soem defintitions of colours based on the Transport for London colour palette and inserted as named colours into
+   the matplotlib colour tables.
+
+The package is fully documented (see link below) and comes with a set of examples that also server as unit tests.
+
+## Documentation
+
+Documentation can be found on the [github pages for this repository](https://stonerlab.github.io/stonerplots/index.html).
+
+## Available Styles
+
+### Core 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
+- thesis - a style that tries to look like the CM Physics group LaTeX thesis template
+
+### Journal Styles
+
+- nature - for Nature group journals - from the original scienceplots package
+- aaas-science - Science single columne style.
+- ieee - for IEEE Transactions journals - from the original scienceplots package
+- aps - for American Physical Society Journals (like Phys Rev Lett etc.)
+- aip - for AIP journals such as Applied Physics Letters - labels in Serif Fonts
+- iop - for Institute of Physics Journals.
+
+### Modifiers
+
+- aps1.5 - Switch to 1.5 column wide format
+- aps2.0 - Switch to 2 column wide format
+- aip2 - Switch to 2 column wide format for AIP journals
+- stoner-dark - Switch to a dark background a lighter plotting colours.
+- hi-res - Switches to 600dpi plotting (but using eps, pdf or svg is generally a better option)
+- med-res - like hi-res, but switches to 300dpi plotting.
+- presentation_sm - a style for making 1/2 width graphs.
+- presentation_dark - tweak the weight of elements for dark presnetations.
+- science-2col, science-3col - Science 2 and 3 column width figures
+- thesis-sm - reduces the figure width to make the axes closer to 4/3 aspect ratio.
+
+## Context Managers
+
+The package is designed to work by using python context managers to aid plotting. These include:
+
+- SavedFigure - apply style sheets and then save any resulting figures to disc in one or more formats
+- StackVertical - make a multi-panel plot where the panels are arranged in a vertical stack and pushed together so that
+  the top-x-axis on one frame is the bottom of the next.
+- MultiPanel - a general; purpose miulti-panel plotting helper.
+- InsetPlot - create an inset set of axes.
+- DoubleYAxis - setup the righthand y axis for a second scale and optional colour the y-axes differently and merge
+  the legend into a single legend.
+
+## 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
+
+## Reference
+
+The package adds these as named colours in matplotlib, along with 90,50,70 and 10% shade variants of some of them. See
+the [documentation page on colours](https://stonerlab.github.io/stonerplots/colours.html) for a full list.
+
+This package draws heavily on [scienceplots](https://github.com/garrettj403/SciencePlots), so it
+seems only fair to cite the original work....
+
+    @software{john_garrett_2023_10206719,
+      author       = {John Garrett and
+                      Echedey Luis and
+                      H.-H. Peng and
+                      Tim Cera and
+                      gobinathj and
+                      Josh Borrow and
+                      Mehmet Keçeci and
+                      Splines and
+                      Suraj Iyer and
+                      Yuming Liu and
+                      cjw and
+                      Mikhail Gasanov},
+      title        = {garrettj403/SciencePlots: 2.1.1},
+      month        = nov,
+      year         = 2023,
+      publisher    = {Zenodo},
+      version      = {2.1.1},
+      doi          = {10.5281/zenodo.10206719},
+      url          = {https://doi.org/10.5281/zenodo.10206719},
+    }
+
+The doi and BibTex reference for stonerplots is: https://doi.org/10.5281/zenodo.14026874
+
+    @software{gavin_burnell_2024_14026874,
+      author       = {Gavin Burnell},
+      title        = {stonerlab/stonerplots},
+      month        = nov,
+      year         = 2024,
+      publisher    = {Zenodo},
+      version      = {v1.5.2},
+      doi          = {10.5281/zenodo.14026874},
+      url          = {https://doi.org/10.5281/zenodo.14026874},
+}