Skip to content

Commit

Permalink
SpiceyPy v4.0.1
Browse files Browse the repository at this point in the history
Added
- docs info about ARM support, currently limited to conda-forge spiceypy
- docs citation info/basic intro
- hash checksums for test kernels
- offline install ci tests
- warn_deprecated_args function to aid future deprecations

Deprecated
- added deprecation warnings for ncol/nrow params for: mtxmg, mtxvg,
mxm, mxmg, mxmt, mxmtg, mxvg, vtmvg, xposeg pending next major release.
- added deprecation warnings for ndim param for: unormg, vaddg, vdistg,
vdotg, vequg, vhatg, vminug, vnromg, vrelg, vsclg, vsepg, vsubg, vzerog
pending next major release.

Changed
- copyright year
- a number of typehints to accept np.ndarray
- changed test_wrapper to use a pytest autouse fixture to call
reset/kclear automatically for most tests

Fixed
- missing docs for xf2eul
- numpy bool_ deprecation warnings
- numpy float warning
- type hint for appndd
  • Loading branch information
AndrewAnnex committed May 31, 2021
1 parent f7b213e commit 8232fc9
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All notable changes to SpiceyPy will be documented here
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project tries to adhere to [Semantic Versioning](http://semver.org/).

## [4.0.1] - 2021-
## [4.0.1] - 2021-05-31
### Added
- docs info about ARM support, currently limited to conda-forge spiceypy
- docs citation info/basic intro
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@
# built documents.
#
# The short X.Y version.
version = "4.0.0"
version = "4.0.1"
# The full version, including alpha/beta/rc tags.
release = "4.0.0"
release = "4.0.1"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def run(self):


class GetCSPICECommand(Command):
""" Custom command to get the correct cspice and build the shared library for spiceypy """
"""Custom command to get the correct cspice and build the shared library for spiceypy"""

description = "downloads cspice and builds the shared library"
user_options = []
Expand All @@ -92,7 +92,7 @@ def run(self):


class BuildPyCommand(build_py):
""" Custom build command to ensure cspice is built and packaged """
"""Custom build command to ensure cspice is built and packaged"""

def run(self):
InstallCSpice.get_cspice()
Expand All @@ -111,7 +111,7 @@ def run(self):

setup(
name="spiceypy",
version="4.0.0",
version="4.0.1",
license="MIT",
author="Andrew Annex",
author_email="[email protected]",
Expand Down
2 changes: 1 addition & 1 deletion spiceypy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
SOFTWARE.
"""
__author__ = "AndrewAnnex"
__version__ = "4.0.0"
__version__ = "4.0.1"

from .spiceypy import *
from .utils import support_types
Expand Down
25 changes: 20 additions & 5 deletions spiceypy/spiceypy.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ def warn_deprecated_args(**kwargs) -> None:
warnings.warn(
f"Specifying any of: {varnames} will be deprecated as of SpiceyPy 5.0.0",
DeprecationWarning,
stacklevel=2
stacklevel=2,
)
pass

Expand Down Expand Up @@ -8974,7 +8974,13 @@ def mxmt(


@spice_error_check
def mxmtg(m1: Union[ndarray, Iterable[Iterable[float]]], m2: Union[ndarray, Iterable[Iterable[float]]], nrow1: OptionalInt = None, nc1c2: OptionalInt = None, nrow2: OptionalInt = None) -> ndarray:
def mxmtg(
m1: Union[ndarray, Iterable[Iterable[float]]],
m2: Union[ndarray, Iterable[Iterable[float]]],
nrow1: OptionalInt = None,
nc1c2: OptionalInt = None,
nrow2: OptionalInt = None,
) -> ndarray:
"""
Multiply a matrix and the transpose of a matrix, both of arbitrary size.
Expand Down Expand Up @@ -9019,7 +9025,12 @@ def mxv(m1: ndarray, vin: ndarray) -> ndarray:


@spice_error_check
def mxvg(m1: Union[ndarray, Iterable[Iterable[float]]], v2: Union[ndarray, Iterable[Iterable[float]]], nrow1: OptionalInt = None, nc1r2: OptionalInt = None) -> ndarray:
def mxvg(
m1: Union[ndarray, Iterable[Iterable[float]]],
v2: Union[ndarray, Iterable[Iterable[float]]],
nrow1: OptionalInt = None,
nc1r2: OptionalInt = None,
) -> ndarray:
"""
Multiply a matrix and a vector of arbitrary size.
Expand Down Expand Up @@ -14621,7 +14632,9 @@ def vadd(

@spice_error_check
def vaddg(
v1: Union[ndarray, Iterable[float]], v2: Union[ndarray, Iterable[float]], ndim: OptionalInt = None
v1: Union[ndarray, Iterable[float]],
v2: Union[ndarray, Iterable[float]],
ndim: OptionalInt = None,
) -> ndarray:
"""
Add two n-dimensional vectors
Expand Down Expand Up @@ -15104,7 +15117,9 @@ def vrel(

@spice_error_check
def vrelg(
v1: Union[ndarray, Iterable[float]], v2: Union[ndarray, Iterable[float]], ndim: OptionalInt = None
v1: Union[ndarray, Iterable[float]],
v2: Union[ndarray, Iterable[float]],
ndim: OptionalInt = None,
) -> float:
"""
Return the relative difference between two vectors of general dimension.
Expand Down

0 comments on commit 8232fc9

Please sign in to comment.