semvec/pypi-packages huggingface dataset:
pyn2 0.1.0
A python tool for N-squared chart plotting
License: Apache Licence 2.0
Requires Python: <4.0,>=3.12
Keywords: N2 chart, Visualization, Data Visualization, Charts, Graphs, Python Chart Library, Plotting, Data Analysis, Charting Library, Scientific Computing, System Engineering

# PyN2

<div align="center">
  <img src="https://raw.githubusercontent.com/leomariga/pyn2/main/doc/logo.jpg"><br>
</div>

**PyN2** is a Python library (based on [OpenMDAO](https://github.com/OpenMDAO/OpenMDAO) project), designed to easily create dynamic **n-squared (N²) charts**. N² charts are essential in systems engineering and project management to visualize and manage complex interactions between components, subsystems, or processes. PyN2 provides an intuitive API to generate customizable N² diagrams.

## Features
- Generate n² charts to visualize component interactions
- Customizable labels for rows and columns
- Highlight important relationships and dependencies
- Export charts in various formats (e.g., SVG, HTML)
- Easy-to-use API with minimal setup

## Use Cases
- Systems engineering: Interface mapping and interaction management
- Project management: Task dependencies and relationship tracking
- Complex system design: Visualizing module communications and dependencies

## Installation
```bash
pip install pyn2
```

## Dependencies

PyN2 relies on the following dependencies, which are managed through Poetry:

```toml
[tool.poetry.dependencies]
python = "^3.12"
openmdao = "^3.34.2"
```

## Usage

Run the following code to generate the `gen_diag.html` file.

```python
from pyn2.chart import Element, Group, N2

n2 = N2('test_chart')
s_dev = Group('Software_development')
e_analyze = Element('Analyze')
e_code = Element('Code')
e_build = Element('Build')
e_deploy = Element('Deploy')

t_vnv = Group('Software_vnv')
e_review = Element('Review')
e_test = Element('Test')

e_analyze.connect_to(e_code)
e_code.connect_to(e_build)
e_code.connect_to(e_review)
e_review.connect_to(e_analyze)
e_build.connect_to(e_test)
e_test.connect_to(e_deploy)
e_test.connect_to(e_analyze)

s_dev.add_element(e_analyze)
s_dev.add_element(e_code)
s_dev.add_element(e_build)
s_dev.add_element(e_deploy)

t_vnv.add_element(e_review)
t_vnv.add_element(e_test)

n2.add_group(s_dev)
n2.add_group(t_vnv)
n2.generate_report()
```

And produce the following chart:

<div align="center">
  <img src="https://raw.githubusercontent.com/leomariga/pyn2/main/doc/example.gif"><br>
</div>


## Contributing is awesome!

See [CONTRIBUTING](https://github.com/leomariga/pyn2/blob/main/CONTRIBUTING.md)




## Contact

Developed with :heart: by the internet


Mainteiner: [Leonardo Mariga](https://github.com/leomariga) 

Did you like it? Remember to click on :star2: button.