plot-misc 2.0.2__tar.gz

plot_misc-2.0.2/LICENSE

@@ -0,0 +1,18 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+Copyright (C) 2024  Amand Floriaan Schmidt (amand.schmidt@ucl.ac.uk)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+

plot_misc-2.0.2/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: plot-misc
+Version: 2.0.2
+Summary: Various plotting templates built on top of matplotlib
+Author-email: A Floriaan Schmidt <floriaanschmidt@gmail.com>
+License-Expression: GPL-3.0-or-later
+Project-URL: Homepage, https://gitlab.com/SchmidtAF/plot-misc
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Requires-Dist: scipy
+Requires-Dist: scikit-learn
+Requires-Dist: adjustText
+Provides-Extra: dev
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Dynamic: license-file
+
+# A collection of plotting functions
+__version__: `2.0.2`
+
+
+This repository collects plotting modules written on top of `matplotlib` or
+`seaborn`. 
+The functions are intended to set-up a light-touch basic illustration which 
+can be customised using the normal matplotlib interface using axes and figures. 
+
+
+The documentation for plot-misc can be found [here](https://SchmidtAF.gitlab.io/plot-misc/). 
+
+
+## Installation 
+At present, this package is undergoing development and no packages exist yet on PyPI.
+Therefore it is recommended that you install in either of the two ways below.
+
+### Installation using conda
+I maintain a conda package in my personal conda channel. To install from this please run:
+
+```
+conda install afschmidt::plot_misc
+```
+
+### Installation using pip
+
+You can install using pip from the root of the cloned repository,
+first clone and cd into the repository root:
+
+```sh
+git clone git@gitlab.com:SchmidtAF/plot-misc.git
+cd plot-misc
+```
+
+Install the dependencies:
+
+```sh
+# From the root of the repository
+conda env create --file ./resources/conda/envs/conda_create.yaml
+```
+
+To add to an existing environment use:
+
+```sh
+# From the root of the repository
+conda env update --file ./resources/conda/envs/conda_update.yaml
+```
+
+Next the package can be installed: 
+
+```sh
+python -m pip install .
+```
+
+Or for an editable (developer) install run the command below from the root of 
+the repository.
+The difference with this is that you can just run `git pull` to 
+update repository, or switch branches without re-installing:
+
+```sh
+python -m pip install -e .
+
+```
+
+## Next steps...
+After installation you might wish to try the `pytest` to confirm 
+everything is in working order. 
+
+```sh
+# From the root of the repository
+pytest tests
+```
+
+## Usage
+
+Please have a look at the examples in 
+[resources](https://gitlab.com/SchmidtAF/plot-misc/-/tree/master/resources/examples)
+for some possible recipes. 
+

plot_misc-2.0.2/README.md

@@ -0,0 +1,79 @@
+# A collection of plotting functions
+__version__: `2.0.2`
+
+
+This repository collects plotting modules written on top of `matplotlib` or
+`seaborn`. 
+The functions are intended to set-up a light-touch basic illustration which 
+can be customised using the normal matplotlib interface using axes and figures. 
+
+
+The documentation for plot-misc can be found [here](https://SchmidtAF.gitlab.io/plot-misc/). 
+
+
+## Installation 
+At present, this package is undergoing development and no packages exist yet on PyPI.
+Therefore it is recommended that you install in either of the two ways below.
+
+### Installation using conda
+I maintain a conda package in my personal conda channel. To install from this please run:
+
+```
+conda install afschmidt::plot_misc
+```
+
+### Installation using pip
+
+You can install using pip from the root of the cloned repository,
+first clone and cd into the repository root:
+
+```sh
+git clone git@gitlab.com:SchmidtAF/plot-misc.git
+cd plot-misc
+```
+
+Install the dependencies:
+
+```sh
+# From the root of the repository
+conda env create --file ./resources/conda/envs/conda_create.yaml
+```
+
+To add to an existing environment use:
+
+```sh
+# From the root of the repository
+conda env update --file ./resources/conda/envs/conda_update.yaml
+```
+
+Next the package can be installed: 
+
+```sh
+python -m pip install .
+```
+
+Or for an editable (developer) install run the command below from the root of 
+the repository.
+The difference with this is that you can just run `git pull` to 
+update repository, or switch branches without re-installing:
+
+```sh
+python -m pip install -e .
+
+```
+
+## Next steps...
+After installation you might wish to try the `pytest` to confirm 
+everything is in working order. 
+
+```sh
+# From the root of the repository
+pytest tests
+```
+
+## Usage
+
+Please have a look at the examples in 
+[resources](https://gitlab.com/SchmidtAF/plot-misc/-/tree/master/resources/examples)
+for some possible recipes. 
+

plot_misc-2.0.2/plot_misc/__init__.py

@@ -0,0 +1 @@
+from ._version import __version__

plot_misc-2.0.2/plot_misc/_version.py

@@ -0,0 +1 @@
+__version__ = '2.0.2'