Metadata-Version: 2.1
Name: faebryk
Version: 0.0.1
Summary: Open-source software-defined EDA
Home-page: https://github.com/faebryk/faebryk
Author: ioannis_iteng
Author-email: ioannis@iteng.nl
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/faebryk/faebryk/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# faebryk

Open-source software-defined EDA

## Get running
Setup
```
> git clone git@github.com:faebryk/faebryk.git
> cd faebryk
> git submodule init
> git submodule update
> pip install -r requirements.txt
```
Run
```
> ./samples/experiment.py | tail -n1 > netlist.net
```

## Running your own experiments/Making samples
First follow the steps in get running.
Then add a file in samples/ (you can use experiment.py as template).
Call your file with `python3 samples/<yourfile>.py`.

## Running tests
Setup
```
> pip install -r test/requirements.txt
```
Run
```
> python3 test/test.py
```


## Dependencies
- networkx

## Contibuting
See [CONTRIBUTING.md](CONTRIBUTING.md)

## Community Support
Community support is provided via Discord; see the Resources below for details.

### Resources
- Source Code: https://github.com/faebryk/faebryk
- Chat: Real-time chat happens in faebryk's Discord Server. Use this Discord [Invite](https://discord.gg/Sekvbrej8j) to register
- Issues: https://github.com/faebryk/faebryk/issues


