vectorose 0.2.1__tar.gz

vectorose-0.2.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023-, Benjamin Z. Rudski, Joseph Deering
+
+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.
+

vectorose-0.2.1/PKG-INFO

@@ -0,0 +1,295 @@
+Metadata-Version: 2.3
+Name: vectorose
+Version: 0.2.1
+Summary: Plot polar and spherical histograms from orientation data.
+License: MIT
+Author: Benjamin Z. Rudski
+Author-email: benjamin.rudski@mail.mcgill.ca
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+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 :: 3.13
+Requires-Dist: imageio-ffmpeg (>=0.5.1,<1)
+Requires-Dist: imageio[ffmpeg,pyav] (>=2.27.0)
+Requires-Dist: importlib-metadata (>=7.0.1)
+Requires-Dist: ipywidgets (>=8.1.5,<9)
+Requires-Dist: matplotlib (>=3.3.4)
+Requires-Dist: numpy (>=1.19.5,<2)
+Requires-Dist: openpyxl (>=3.1.2,<4)
+Requires-Dist: pandas (>=1.1.3)
+Requires-Dist: pyvista[all,jupyter,trame] (>=0.44.1,<1)
+Requires-Dist: scipy (>=1.14,<2)
+Requires-Dist: trame (>=3.6.5,<4)
+Requires-Dist: trimesh[easy] (>=4.3.0,<5)
+Project-URL: Documentation, https://vectorose.readthedocs.io/en/latest/index.html
+Project-URL: Homepage, https://github.com/bzrudski/vectorose
+Project-URL: Repository, https://github.com/bzrudski/vectorose
+Description-Content-Type: text/markdown
+
+# VectoRose
+
+![VectoRose: visualise and analyse 3D directed data](./resources/splash/splash.png)
+
+Spherical and polar histogram plotting for non-unit vectorial and axial
+data.
+
+## Overview
+
+Many fields of science rely on oriented data. In these contexts, scalar
+values alone can't describe the quantities under consideration. The values
+of interest are **vectors**, consisting of a *direction* or *orientation*,
+in addition to an optional magnitude (length). Examples include wind
+velocities, trabecular bone co-alignment (anisotropy) and cardiac fibre
+orientations.
+
+Traditional histograms and statistical tools can't be directly applied to
+analyse these data. To be able to visualise and quantitatively describe and
+analyse oriented datasets in 3D, we present **VectoRose**.
+
+### Features
+
+**VectoRose** provides tools for *visualising* and quantitatively
+*analysing* data sets consisting of vectors and orientations of unit and
+non-unit length.
+
+Using VectoRose, it is possible to:
+
+* Construct spherical histograms of directions and orientations in 3D.
+* Construct 1D scalar histograms of vector magnitudes.
+* Construct nested spherical histograms to understand collections of 
+  non-unit vectors and axes.
+* Construct 1D polar histograms of vector orientation spherical coordinate
+  angles.
+* Compute directional statistics to understand the distributions of
+  orientations and directions, as described by Fisher, Lewis and
+  Embleton.[^fle]
+
+![Nested shells representing vectors of non-unit length.](./resources/sample_plots/nested_shells.gif)
+
+![Rotation animation showing various orientations.](./resources/sample_plots/rotating_orientation.gif)
+
+## Installation
+
+VectoRose can be installed from PyPI using `pip`.
+
+```bash
+$ pip install vectorose
+```
+
+Alternatively, you can install it from source by cloning this repository.
+
+## Usage
+
+To use VectoRose, you must have a collection of **3D vectors** stored in a
+NumPy array. These may be read from a NumPy file (`*.npy`) or a
+comma-separated values (`*.csv`) file using the functions provided in
+VectoRose.
+
+VectoRose must be imported in order to be used. We recommend using the
+alias `vr` when importing VectoRose:
+
+```python
+import vectorose as vr
+```
+
+### Histogram Construction
+
+Histogram construction requires two steps:
+
+1. Assigning all vectors to magnitude and orientation bins.
+2. Computing histograms and generating the histogram plots.
+
+The first step requires a discrete representation of a sphere, such as a
+fine Tregenza sphere, which divides the surface of the sphere into 5806
+faces, most of which are rectangular, of approximately equal surface area.
+Two keyword arguments can be used to set the number of magnitude bins
+(`number_of_shells`) and to fix the histogram domain (`magnitude_range`).
+
+In the second step, a variety of histograms can be constructed. These
+histograms may consider the counts (or frequencies) of vectors at each
+combination of magnitude and direction (*bivariate histogram*), or within
+the bins of each variable separately (*marginal histograms*). Histograms
+can also be constructed that consider relative frequencies of one variable
+within a specific range of the other (*conditional histograms*).
+
+In this brief code snippet, we will generate some random vectors from a
+von Mises-Fisher unimodal directional distribution, with some noise in the
+magnitude. We'll then construct the bivariate histogram and visualise it in
+3D using PyVista.
+
+```python
+import vectorose as vr
+import vectorose.mock_data
+
+# Create random vectors for demonstration
+my_vectors = vr.mock_data.create_vonmises_fisher_vectors_single_direction(
+    phi=45,
+    theta=70,
+    kappa=20,
+    number_of_points=10000,
+    magnitude=1.0,
+    magnitude_std=0.25,
+    use_degrees=True,
+    seed=20250317,
+)
+
+# Construct the discrete sphere representation
+my_sphere = vr.tregenza_sphere.FineTregenzaSphere(number_of_shells=10)
+my_binned_vectors, magnitude_bin_edges = my_sphere.assign_histogram_bins(my_vectors)
+
+# Compute the bivariate histogram
+my_histogram = my_sphere.construct_histogram(my_binned_vectors, return_fraction=False)
+
+# Generate the histogram meshes
+my_histogram_meshes = my_sphere.create_histogram_meshes(my_histogram, magnitude_bin_edges)
+
+# Create a 3D SpherePlotter to view the histogram in 3D and show it
+my_sphere_plotter = vr.plotting.SpherePlotter(my_histogram_meshes)
+my_sphere_plotter.produce_plot()
+my_sphere_plotter.show()
+```
+
+![Shell animation for VectoRose example](./resources/readme_examples/histogram_construction_shells.gif)
+
+When this code is run in a Jupyter notebook, an interactive plotting output
+will appear beneath the code cell. When this code is run in a Python
+console, a new interactive window will appear that blocks the main thread.
+
+In addition to showing the plot in 3D, VectoRose includes various functions
+to produce animations and screenshots of spherical histograms.
+
+### Directional Statistics
+
+The functions in the `vectorose.stats` module enable directional statistics
+to be computed. These functions have been adapted from the work by Fisher,
+Lewis and Embleton.[^fle]
+
+VectoRose implements a variety of descriptive statistics and hypothesis
+tests. Most of these consider pure directions or orientations, which are
+represented as unit vectors.
+
+In this code snippet, we generate two sets of mock vectors: a cluster,
+following a von Mises-Fisher distribution, and a girdle, following a Watson
+distribution with a negative parameter value. We then compute Woodcock's
+shape and strength parameters, as described by Woodcock[^woodcock] and as
+explained by Fisher, Lewis and Embleton.[^fle]
+
+```python
+import vectorose as vr
+import vectorose.mock_data
+import numpy as np
+
+# Create random vectors for demonstration
+my_cluster_vectors = vr.mock_data.create_vonmises_fisher_vectors_single_direction(
+    phi=45,
+    theta=70,
+    kappa=20,
+    number_of_points=10000,
+    magnitude=1.0,
+    magnitude_std=0,
+    use_degrees=True,
+    seed=20250318,
+)
+
+direction = np.array([1, 0, 0])
+my_girdle_vectors = vr.mock_data.generate_watson_distribution(
+    direction, -20, n=10000, seed=20250318
+)
+
+# Compute Woodcock's parameters for both sets of vectors
+cluster_orientation_matrix_eigs, _ = vr.stats.compute_orientation_matrix_eigs(
+    my_cluster_vectors
+)
+girdle_orientation_matrix_eigs, _ = vr.stats.compute_orientation_matrix_eigs(
+    my_girdle_vectors
+)
+
+cluster_woodcock_parameters = vr.stats.compute_orientation_matrix_parameters(
+    cluster_orientation_matrix_eigs
+)
+girdle_woodcock_parameters = vr.stats.compute_orientation_matrix_parameters(
+    girdle_orientation_matrix_eigs
+)
+
+print(f"The VMF distribution has shape parameter {cluster_woodcock_parameters.shape_parameter:.3f}"
+      f" and strength parameter {cluster_woodcock_parameters.strength_parameter:.3f}.")
+
+print(f"The Watson distribution has shape parameter {girdle_woodcock_parameters.shape_parameter:.3f}"
+      f" and strength parameter {girdle_woodcock_parameters.strength_parameter:.3f}.")
+```
+
+Running this code produces the following output:
+```
+The VMF distribution has shape parameter 48.085 and strength parameter 2.987.
+The Watson distribution has shape parameter 0.005 and strength parameter 2.955.
+```
+
+Additional statistical operations are provided in the VectoRose API and are
+described in the **User's Guide**.
+
+## Citation
+
+If you've found VectoRose helpful for your research, please cite our
+publication:
+
+```
+TBA
+```
+
+If you've modelled your analysis based on our sample case studies, please
+also cite the following:
+
+```
+TBA
+```
+
+## Contributing
+
+Interested in contributing? Check out the contributing guidelines. Please
+note that this project is released with a Code of Conduct. By contributing
+to this project, you agree to abide by its terms.
+
+VectoRose is built on a number of existing, well-supported open-source
+packages, including: [NumPy](https://numpy.org/),
+[PyVista](https://docs.pyvista.org/),
+[Matplotlib](https://matplotlib.org/),
+[pandas](https://pandas.pydata.org/),
+[SciPy](https://scipy.org/) and [trimesh](https://trimesh.org/).
+
+
+## License
+
+VectoRose was created by Benjamin Z. Rudski and Joseph Deering. It is
+licensed under the terms of the MIT license. See the `LICENSE` file for
+more details.
+
+## Acknowledgements
+
+The VectoRose project is developed by Benjamin Z. Rudski and Joseph Deering
+under the supervision of Dr. Natalie Reznikov at McGill University, in
+Montreal, Quebec, Canada &#x1f1e8;&#x1f1e6;.
+
+Works consult in this project are available in our online documentation, as
+well as in [`docs/refs.bib`](./docs/refs.bib). For the directional
+statistics approaches, we made extensive use of *Statistic analysis of
+spherical data* by Fisher, Lewis and Embleton.[^fle]
+
+We also made extensive use of the book [*Python Packages*](https://py-pkgs.org/)
+by Tomas Beuzen and Tiffany Timbers to inform the structure and development
+of this package.
+
+## Credits
+
+`vectorose` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
+
+[^fle]: Fisher, N. I., Lewis, T., & Embleton, B. J. J. (1993).
+  *Statistical analysis of spherical data* ([New ed.], 1. paperback ed).
+  Cambridge Univ. Press. <https://www.cambridge.org/ca/universitypress/subjects/physics/astronomy-general/statistical-analysis-spherical-data?format=PB>
+
+[^woodcock]: Woodcock, N. H. (1977). Specification of fabric shapes using
+  an eigenvalue method. *Geological Society of America Bulletin, 88*(9), 1231.
+  [https://doi.org/10.1130/0016-7606(1977)88<1231:SOFSUA>2.0.CO;2](https://doi.org/10.1130/0016-7606(1977)88<1231:SOFSUA>2.0.CO;2)
+

vectorose-0.2.1/README.md

@@ -0,0 +1,263 @@
+# VectoRose
+
+![VectoRose: visualise and analyse 3D directed data](./resources/splash/splash.png)
+
+Spherical and polar histogram plotting for non-unit vectorial and axial
+data.
+
+## Overview
+
+Many fields of science rely on oriented data. In these contexts, scalar
+values alone can't describe the quantities under consideration. The values
+of interest are **vectors**, consisting of a *direction* or *orientation*,
+in addition to an optional magnitude (length). Examples include wind
+velocities, trabecular bone co-alignment (anisotropy) and cardiac fibre
+orientations.
+
+Traditional histograms and statistical tools can't be directly applied to
+analyse these data. To be able to visualise and quantitatively describe and
+analyse oriented datasets in 3D, we present **VectoRose**.
+
+### Features
+
+**VectoRose** provides tools for *visualising* and quantitatively
+*analysing* data sets consisting of vectors and orientations of unit and
+non-unit length.
+
+Using VectoRose, it is possible to:
+
+* Construct spherical histograms of directions and orientations in 3D.
+* Construct 1D scalar histograms of vector magnitudes.
+* Construct nested spherical histograms to understand collections of 
+  non-unit vectors and axes.
+* Construct 1D polar histograms of vector orientation spherical coordinate
+  angles.
+* Compute directional statistics to understand the distributions of
+  orientations and directions, as described by Fisher, Lewis and
+  Embleton.[^fle]
+
+![Nested shells representing vectors of non-unit length.](./resources/sample_plots/nested_shells.gif)
+
+![Rotation animation showing various orientations.](./resources/sample_plots/rotating_orientation.gif)
+
+## Installation
+
+VectoRose can be installed from PyPI using `pip`.
+
+```bash
+$ pip install vectorose
+```
+
+Alternatively, you can install it from source by cloning this repository.
+
+## Usage
+
+To use VectoRose, you must have a collection of **3D vectors** stored in a
+NumPy array. These may be read from a NumPy file (`*.npy`) or a
+comma-separated values (`*.csv`) file using the functions provided in
+VectoRose.
+
+VectoRose must be imported in order to be used. We recommend using the
+alias `vr` when importing VectoRose:
+
+```python
+import vectorose as vr
+```
+
+### Histogram Construction
+
+Histogram construction requires two steps:
+
+1. Assigning all vectors to magnitude and orientation bins.
+2. Computing histograms and generating the histogram plots.
+
+The first step requires a discrete representation of a sphere, such as a
+fine Tregenza sphere, which divides the surface of the sphere into 5806
+faces, most of which are rectangular, of approximately equal surface area.
+Two keyword arguments can be used to set the number of magnitude bins
+(`number_of_shells`) and to fix the histogram domain (`magnitude_range`).
+
+In the second step, a variety of histograms can be constructed. These
+histograms may consider the counts (or frequencies) of vectors at each
+combination of magnitude and direction (*bivariate histogram*), or within
+the bins of each variable separately (*marginal histograms*). Histograms
+can also be constructed that consider relative frequencies of one variable
+within a specific range of the other (*conditional histograms*).
+
+In this brief code snippet, we will generate some random vectors from a
+von Mises-Fisher unimodal directional distribution, with some noise in the
+magnitude. We'll then construct the bivariate histogram and visualise it in
+3D using PyVista.
+
+```python
+import vectorose as vr
+import vectorose.mock_data
+
+# Create random vectors for demonstration
+my_vectors = vr.mock_data.create_vonmises_fisher_vectors_single_direction(
+    phi=45,
+    theta=70,
+    kappa=20,
+    number_of_points=10000,
+    magnitude=1.0,
+    magnitude_std=0.25,
+    use_degrees=True,
+    seed=20250317,
+)
+
+# Construct the discrete sphere representation
+my_sphere = vr.tregenza_sphere.FineTregenzaSphere(number_of_shells=10)
+my_binned_vectors, magnitude_bin_edges = my_sphere.assign_histogram_bins(my_vectors)
+
+# Compute the bivariate histogram
+my_histogram = my_sphere.construct_histogram(my_binned_vectors, return_fraction=False)
+
+# Generate the histogram meshes
+my_histogram_meshes = my_sphere.create_histogram_meshes(my_histogram, magnitude_bin_edges)
+
+# Create a 3D SpherePlotter to view the histogram in 3D and show it
+my_sphere_plotter = vr.plotting.SpherePlotter(my_histogram_meshes)
+my_sphere_plotter.produce_plot()
+my_sphere_plotter.show()
+```
+
+![Shell animation for VectoRose example](./resources/readme_examples/histogram_construction_shells.gif)
+
+When this code is run in a Jupyter notebook, an interactive plotting output
+will appear beneath the code cell. When this code is run in a Python
+console, a new interactive window will appear that blocks the main thread.
+
+In addition to showing the plot in 3D, VectoRose includes various functions
+to produce animations and screenshots of spherical histograms.
+
+### Directional Statistics
+
+The functions in the `vectorose.stats` module enable directional statistics
+to be computed. These functions have been adapted from the work by Fisher,
+Lewis and Embleton.[^fle]
+
+VectoRose implements a variety of descriptive statistics and hypothesis
+tests. Most of these consider pure directions or orientations, which are
+represented as unit vectors.
+
+In this code snippet, we generate two sets of mock vectors: a cluster,
+following a von Mises-Fisher distribution, and a girdle, following a Watson
+distribution with a negative parameter value. We then compute Woodcock's
+shape and strength parameters, as described by Woodcock[^woodcock] and as
+explained by Fisher, Lewis and Embleton.[^fle]
+
+```python
+import vectorose as vr
+import vectorose.mock_data
+import numpy as np
+
+# Create random vectors for demonstration
+my_cluster_vectors = vr.mock_data.create_vonmises_fisher_vectors_single_direction(
+    phi=45,
+    theta=70,
+    kappa=20,
+    number_of_points=10000,
+    magnitude=1.0,
+    magnitude_std=0,
+    use_degrees=True,
+    seed=20250318,
+)
+
+direction = np.array([1, 0, 0])
+my_girdle_vectors = vr.mock_data.generate_watson_distribution(
+    direction, -20, n=10000, seed=20250318
+)
+
+# Compute Woodcock's parameters for both sets of vectors
+cluster_orientation_matrix_eigs, _ = vr.stats.compute_orientation_matrix_eigs(
+    my_cluster_vectors
+)
+girdle_orientation_matrix_eigs, _ = vr.stats.compute_orientation_matrix_eigs(
+    my_girdle_vectors
+)
+
+cluster_woodcock_parameters = vr.stats.compute_orientation_matrix_parameters(
+    cluster_orientation_matrix_eigs
+)
+girdle_woodcock_parameters = vr.stats.compute_orientation_matrix_parameters(
+    girdle_orientation_matrix_eigs
+)
+
+print(f"The VMF distribution has shape parameter {cluster_woodcock_parameters.shape_parameter:.3f}"
+      f" and strength parameter {cluster_woodcock_parameters.strength_parameter:.3f}.")
+
+print(f"The Watson distribution has shape parameter {girdle_woodcock_parameters.shape_parameter:.3f}"
+      f" and strength parameter {girdle_woodcock_parameters.strength_parameter:.3f}.")
+```
+
+Running this code produces the following output:
+```
+The VMF distribution has shape parameter 48.085 and strength parameter 2.987.
+The Watson distribution has shape parameter 0.005 and strength parameter 2.955.
+```
+
+Additional statistical operations are provided in the VectoRose API and are
+described in the **User's Guide**.
+
+## Citation
+
+If you've found VectoRose helpful for your research, please cite our
+publication:
+
+```
+TBA
+```
+
+If you've modelled your analysis based on our sample case studies, please
+also cite the following:
+
+```
+TBA
+```
+
+## Contributing
+
+Interested in contributing? Check out the contributing guidelines. Please
+note that this project is released with a Code of Conduct. By contributing
+to this project, you agree to abide by its terms.
+
+VectoRose is built on a number of existing, well-supported open-source
+packages, including: [NumPy](https://numpy.org/),
+[PyVista](https://docs.pyvista.org/),
+[Matplotlib](https://matplotlib.org/),
+[pandas](https://pandas.pydata.org/),
+[SciPy](https://scipy.org/) and [trimesh](https://trimesh.org/).
+
+
+## License
+
+VectoRose was created by Benjamin Z. Rudski and Joseph Deering. It is
+licensed under the terms of the MIT license. See the `LICENSE` file for
+more details.
+
+## Acknowledgements
+
+The VectoRose project is developed by Benjamin Z. Rudski and Joseph Deering
+under the supervision of Dr. Natalie Reznikov at McGill University, in
+Montreal, Quebec, Canada 🇨🇦.
+
+Works consult in this project are available in our online documentation, as
+well as in [`docs/refs.bib`](./docs/refs.bib). For the directional
+statistics approaches, we made extensive use of *Statistic analysis of
+spherical data* by Fisher, Lewis and Embleton.[^fle]
+
+We also made extensive use of the book [*Python Packages*](https://py-pkgs.org/)
+by Tomas Beuzen and Tiffany Timbers to inform the structure and development
+of this package.
+
+## Credits
+
+`vectorose` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
+
+[^fle]: Fisher, N. I., Lewis, T., & Embleton, B. J. J. (1993).
+  *Statistical analysis of spherical data* ([New ed.], 1. paperback ed).
+  Cambridge Univ. Press. <https://www.cambridge.org/ca/universitypress/subjects/physics/astronomy-general/statistical-analysis-spherical-data?format=PB>
+
+[^woodcock]: Woodcock, N. H. (1977). Specification of fabric shapes using
+  an eigenvalue method. *Geological Society of America Bulletin, 88*(9), 1231.
+  [https://doi.org/10.1130/0016-7606(1977)88<1231:SOFSUA>2.0.CO;2](https://doi.org/10.1130/0016-7606(1977)88<1231:SOFSUA>2.0.CO;2)

vectorose-0.2.1/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "vectorose"
+version = "0.2.1"
+description = "Plot polar and spherical histograms from orientation data."
+authors = [
+    {name = "Benjamin Z. Rudski", email = "benjamin.rudski@mail.mcgill.ca"},
+    {name = "Joseph Deering", email = "joseph.deering@mcgill.ca"},
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "numpy (>=1.19.5, <2)",
+    "matplotlib>=3.3.4",
+    "pandas>=1.1.3",
+    "openpyxl (>=3.1.2, <4)",
+    "trimesh[easy] (>=4.3.0, <5)",
+    "imageio-ffmpeg (>=0.5.1, <1)",
+    "scipy (>=1.14, <2)",
+    "importlib-metadata>=7.0.1",
+    "pyvista[all, jupyter, trame] (>=0.44.1, <1)",
+    "imageio[ffmpeg, pyav]>=2.27.0",
+    "trame (>=3.6.5, <4)",
+    "ipywidgets (>=8.1.5, <9)",
+]
+
+[project.urls]
+homepage = "https://github.com/bzrudski/vectorose"
+repository = "https://github.com/bzrudski/vectorose"
+documentation = "https://vectorose.readthedocs.io/en/latest/index.html"
+
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.4"
+pytest-cov = "^4.1.0"
+jupyter = "^1.0.0"
+myst-nb = "^1.0.0"
+sphinx-autoapi = "^3.0.0"
+python-semantic-release = "^8.7.0"
+ipympl = "^0.9.4"
+pydata-sphinx-theme = "^0.15.3"
+jupyterlab = ">=3"
+black = "^24.10.0"
+sphinxcontrib-bibtex = "^2.6.3"
+jupytext = "^1.16.4"
+sphinxcontrib-video = "^0.3.1"
+sphinx-design = "^0.6.1"
+sphinx-copybutton = "^0.5.2"
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version"
+]
+branch = "main" # branch to make releases of
+build_command = "poetry build" # build dists
+
+[tool.semantic_release.publish]
+upload_to_vcs_release = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

vectorose-0.2.1/src/vectorose/__init__.py

@@ -0,0 +1,15 @@
+"""VectoRose: A new tool for visualising and analysing directional data."""
+
+from vectorose import polar_data
+from vectorose import plotting
+from vectorose import io
+from vectorose import triangle_sphere
+from vectorose import tregenza_sphere
+from vectorose import util
+from vectorose import stats
+
+from vectorose.sphere_base import SphereBase
+
+from importlib_metadata import version
+
+__version__ = version("vectorose")