pyvlasiator 0.1.3__tar.gz → 0.1.4__tar.gz

{pyvlasiator-0.1.3 → pyvlasiator-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyvlasiator
-Version: 0.1.3
+Version: 0.1.4
 Summary: Python utilities for processing Vlasiator data
 Author: Hongyang Zhou
 Author-email: hyzhou@umich.edu
@@ -17,6 +17,9 @@ Description-Content-Type: text/markdown
 # pyvlasiator
 
 <p align="center">
+  <a href="https://badge.fury.io/py/pyvlasiator">
+    <img src="https://badge.fury.io/py/pyvlasiator.svg" alt="PyPI version" height="18">
+  </a>
   <a href="https://github.com/henry2004y/pyvlasiator/actions">
     <img src="https://github.com/henry2004y/pyvlasiator/actions/workflows/CI.yml/badge.svg">
   </a>

{pyvlasiator-0.1.3 → pyvlasiator-0.1.4}/README.md

@@ -1,6 +1,9 @@
 # pyvlasiator
 
 <p align="center">
+  <a href="https://badge.fury.io/py/pyvlasiator">
+    <img src="https://badge.fury.io/py/pyvlasiator.svg" alt="PyPI version" height="18">
+  </a>
   <a href="https://github.com/henry2004y/pyvlasiator/actions">
     <img src="https://github.com/henry2004y/pyvlasiator/actions/workflows/CI.yml/badge.svg">
   </a>

{pyvlasiator-0.1.3 → pyvlasiator-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyvlasiator"
-version = "0.1.3"
+version = "0.1.4"
 description = "Python utilities for processing Vlasiator data"
 authors = ["Hongyang Zhou <hyzhou@umich.edu>"]
 readme = "README.md"

{pyvlasiator-0.1.3 → pyvlasiator-0.1.4}/src/pyvlasiator/plot/plot.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import numpy as np
+from numpy.typing import ArrayLike
 import math
 import warnings
 from typing import Callable
@@ -182,6 +183,7 @@ def _plot1d(
 
     return c
 
+
 def pcolormesh(
     self: Vlsv,
     var: str = "",
@@ -922,7 +924,6 @@ def vdfslice(
     meta: Vlsv,
     location: tuple | list,
     ax=None,
-    limits: tuple = (float("-inf"), float("inf"), float("-inf"), float("inf")),
     verbose: bool = False,
     species: str = "proton",
     unit: AxisUnit = AxisUnit.SI,
@@ -967,7 +968,15 @@ def vdfslice(
 
     norm = matplotlib.colors.LogNorm(vmin, vmax)
 
-    h = ax.hist2d(v1, v2, bins=(r1, r2), weights=weights, norm=norm, shading="flat")
+    h = ax.hist2d(
+        v1,
+        v2,
+        bins=(r1, r2),
+        weights=weights,
+        norm=norm,
+        shading="flat",
+        **kwargs,
+    )
 
     ax.set_title(str_title, fontweight="bold")
     ax.set_xlabel(strx)

{pyvlasiator-0.1.3 → pyvlasiator-0.1.4}/src/pyvlasiator/vlsv/reader.py

@@ -375,16 +375,17 @@ class Vlsv:
         """
         Read variables as numpy arrays from the open vlsv file.
 
-        Parameters
-        ----------
-        cellids : int or list[int] or np.ndarray
-            If -1 then all data is read. If nonzero then only the vector for the specified
-            cell id or cellids is read.
-        sorted : bool
-            If the returned array is sorted by cell IDs. Only applied for full arrays.
-        Returns
-        -------
-        numpy.ndarray
+        Args:
+            name (str): The name of the variable to read.
+            cellids (int, list[int], np.ndarray, optional):
+                Specifies which cell IDs to read data for. Defaults to -1, which reads data for all cells.
+            - If an integer (except -1), only the data for that specific cell ID is read.
+            - If a list or NumPy array of integers, only the data for the specified cell IDs are read.
+            - Specifying cell IDs is not supported for "FSgrid" or "ionosphere" variables.
+            sorted (bool, optional): If True, the returned array is sorted by cell IDs (only applicable when reading all cells, cellids=-1). Defaults to True.
+
+        Returns:
+            numpy.ndarray
         """
 
         if self.has_variable(name) and name.startswith("fg_"):