Skip to main content

grd

Developer Guide

Setup

# create conda environment
$ mamba env create -f env.yml

# update conda environment
$ mamba env update -n grd --file env.yml

Install

pip install -e .

# install from pypi
pip install grd

nbdev

# activate conda environment
$ conda activate grd

# make sure the grd package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to the grd package
$ nbdev_prepare

Publishing

# publish to pypi
$ nbdev_pypi

# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/dsm-72/grd.git

or from conda

$ conda install -c dsm-72 grd

or from pypi

$ pip install grd

Documentation

Documentation can be found hosted on GitHub repository pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

abc, d = Literal['a', 'b', 'c'], 'd'
class ABC_Guard(TTypeGuard):
    types = abc

ABC_Guard.istype('bz'), ABC_Guard.istype('b')
(False, True)
class ABCD_Guard(TTypeGuard):
    types = Union[abc, d]
    
ABCD_Guard.istype('b'), ABCD_Guard.istype('d')
(True, True)
import numpy as np
from typing import TypeAlias
ndarray: TypeAlias = np.ndarray

class NPArrayGuard(TTypeGuard):
    types = ndarray

NPArrayGuard.istype([1,2,3]), NPArrayGuard.istype(np.array([1,2,3]))
(False, True)

Metadata

Release files for grd 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for grd 0.0.1
File Size Uploaded Provenance Actions
grd-0.0.1.tar.gz 10.2 kB Without provenance Details for grd-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for grd 0.0.1
File Interpreter ABI Platform Actions
grd-0.0.1-py3-none-any.whl Python 3 none any Details for grd-0.0.1-py3-none-any.whl

Total release size: 20.1 kB

Release files / grd-0.0.1.tar.gz

Download URL grd-0.0.1.tar.gz
Size 10.2 kB
Tags Source
SHA-256 checksum
How to use checksums
7c3f94be98edef22b9aa1c51fd5acac946682d6d7fec78808bf537246230d58f
BLAKE2b-256 checksum
How to use checksums
d66853d6dcfa2c7483d3e1c23234963ce2ad2905227145670adcdefc82d58e4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / grd-0.0.1-py3-none-any.whl

Download URL grd-0.0.1-py3-none-any.whl
Size 9.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6a078c50e7d86d343d1aa019153fb8ab063f4a7e1320681ad94eeffedd2fcdaf
BLAKE2b-256 checksum
How to use checksums
1bc9302f3bb89a36744d1cad2ed3914227a23c08b8e33c8fecab18e298cdb296
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Security for grd 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page