https://github.com/zincware/znlib

The znlib package
https://github.com/zincware/znlib

Last synced: 9 months ago
JSON representation

The znlib package

• Host: GitHub
• URL: https://github.com/zincware/znlib
• Owner: zincware
• License: apache-2.0
• Created: 2022-10-28T15:22:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-09T13:07:22.000Z (about 3 years ago)
• Last Synced: 2025-08-23T21:39:32.486Z (9 months ago)
• Language: Python
• Size: 633 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Coverage Status](https://coveralls.io/repos/github/zincware/znlib/badge.svg?branch=main)](https://coveralls.io/github/zincware/znlib?branch=main)

![PyTest](https://github.com/zincware/znlib/actions/workflows/pytest.yaml/badge.svg)

[![PyPI version](https://badge.fury.io/py/znlib.svg)](https://badge.fury.io/py/znlib)

[![ZnTrack](https://img.shields.io/badge/Powered%20by-ZnTrack-%23007CB0)](https://zntrack.readthedocs.io/en/latest/)

[![zincware](https://img.shields.io/badge/Powered%20by-zincware-darkcyan)](https://github.com/zincware)

# znlib

This package provides you with a CLI to list your installed zincware libraries.

When installing via `pip install znlib[zntrack]` your output should look something like:

```

>>> znlib

Available zincware packages:

  ✓  znlib       (0.1.0)

  ✓  zntrack     (0.4.3)

  ✗  mdsuite 

  ✓  znjson      (0.2.1)

  ✓  zninit      (0.1.1)

  ✓  dot4dict    (0.1.1)

  ✗  znipy 

  ✗  supercharge 

  ✗  znvis 

  ✗  symdet 

```

Furthermore, `znlib` provides you with some example [ZnTrack](https://github.com/zincware/ZnTrack) Nodes.

```python

from znlib.examples import MonteCarloPiEstimator

mcpi = MonteCarloPiEstimator(n_points=1000).write_graph(run=True)

print(mcpi.load().estimate)

>>> 3.128

```

The idea of the `znlib` package is to provide a collection of [ZnTrack](https://github.com/zincware/ZnTrack) Nodes from all different fields of research.

Every contribution is very welcome.

For new Nodes:

1. Fork this repository.

2. Create a file under the directory `znlib/examples`

3. Make a Pull request.