https://github.com/chrismathew05/cir

Tool to document/explore graph relations between circuit components.
https://github.com/chrismathew05/cir

circuits graph-algorithms jupyter-notebook python

Last synced: 6 days ago
JSON representation

Tool to document/explore graph relations between circuit components.

• Host: GitHub
• URL: https://github.com/chrismathew05/cir
• Owner: chrismathew05
• License: mit
• Created: 2022-07-19T17:16:47.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-31T23:18:13.000Z (about 2 years ago)
• Last Synced: 2023-08-12T18:41:55.372Z (over 1 year ago)
• Topics: circuits, graph-algorithms, jupyter-notebook, python
• Language: Jupyter Notebook
• Homepage: https://cir.readthedocs.io/en/latest/
• Size: 282 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CIRCUIT GRAPHER

This application is used at Intelline to document circuits and explore the relationships between components.

## Build

1. Fork and clone repo: `https://github.com/chrismathew05/cir`

2. Create and activate python virtual environment `venv`.

3. Create a local `.gitignore` and `.env` file (unused for now).

4. Install requirements: `pip install -r requirements-prod.txt`

5. Provide build script permissions: `chmod -R 777 build.sh`

6. Run the build script and ensure all tests pass: `./build.sh`.

## Usage

1. Save XML (e.g. `test.xml`) + DTD (e.g. `test.dtd`) files in the `circuit` directory.

2. Restart `main.ipynb`.

3. Use the notebook to construct/explore your circuit.

## TODO

- [x] Complete sphinx documentation

- [x] Unit test cases

- [ ] Finish constructiong circuit XML + DTD