Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
B-ASIC - Better ASIC Toolbox
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Computer Engineering
B-ASIC - Better ASIC Toolbox
Commits
4fe269f5
Commit
4fe269f5
authored
5 months ago
by
Simon Bjurek
Browse files
Options
Downloads
Patches
Plain Diff
updated readme
parent
c3b22def
No related branches found
No related tags found
1 merge request
!463
Removed requirement txt files and added optional dependencies instead.
Pipeline
#155565
passed
5 months ago
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+13
-7
13 additions, 7 deletions
README.md
with
13 additions
and
7 deletions
README.md
+
13
−
7
View file @
4fe269f5
...
@@ -15,7 +15,7 @@ How to build and debug the library during development.
...
@@ -15,7 +15,7 @@ How to build and debug the library during development.
The following packages are required in order to build the library:
The following packages are required in order to build the library:
-
[
Python
](
https://python.org/
)
3.10+
-
[
Python
](
https://python.org/
)
3.10+
-
Python dependencies (install with
`pip install
-r requirements.txt
`
or they will be installed as part of the
-
Python dependencies (install with
`pip install
.
`
or they will be installed as part of the
installation process):
installation process):
-
[
Graphviz
](
https://graphviz.org/
)
-
[
Graphviz
](
https://graphviz.org/
)
-
[
Matplotlib
](
https://matplotlib.org/
)
-
[
Matplotlib
](
https://matplotlib.org/
)
...
@@ -24,7 +24,7 @@ The following packages are required in order to build the library:
...
@@ -24,7 +24,7 @@ The following packages are required in order to build the library:
-
[
setuptools_scm
](
https://github.com/pypa/setuptools_scm/
)
-
[
setuptools_scm
](
https://github.com/pypa/setuptools_scm/
)
-
[
NetworkX
](
https://networkx.org/
)
-
[
NetworkX
](
https://networkx.org/
)
-
[
QtAwesome
](
https://github.com/spyder-ide/qtawesome/
)
-
[
QtAwesome
](
https://github.com/spyder-ide/qtawesome/
)
-
Qt 6, with Python bindings, one of:
-
Qt 6, with Python bindings, one of:
(install with
`pip install .[$BINDING_NAME]`
)
-
pyqt6
-
pyqt6
-
pyside6
-
pyside6
...
@@ -35,7 +35,7 @@ To build a binary distribution, the following additional packages are required:
...
@@ -35,7 +35,7 @@ To build a binary distribution, the following additional packages are required:
To run the test suite, the following additional packages are required:
To run the test suite, the following additional packages are required:
-
Python (install with
`pip install
-r requirements_test.txt
`
):
-
Python (install with
`pip install
.[test]
`
):
-
[
pytest
](
https://pytest.org/
)
-
[
pytest
](
https://pytest.org/
)
-
[
pytest-qt
](
https://pytest-qt.readthedocs.io/
)
-
[
pytest-qt
](
https://pytest-qt.readthedocs.io/
)
-
[
pytest-mpl
](
https://github.com/matplotlib/pytest-mpl/
)
-
[
pytest-mpl
](
https://github.com/matplotlib/pytest-mpl/
)
...
@@ -45,7 +45,7 @@ To run the test suite, the following additional packages are required:
...
@@ -45,7 +45,7 @@ To run the test suite, the following additional packages are required:
To generate the documentation, the following additional packages are required:
To generate the documentation, the following additional packages are required:
-
Python (install with
`pip install
-r requirements_doc.txt
`
):
-
Python (install with
`pip install
.[doc]
`
):
-
[
Sphinx
](
https://www.sphinx-doc.org/
)
-
[
Sphinx
](
https://www.sphinx-doc.org/
)
-
[
Furo
](
https://pradyunsg.me/furo/
)
-
[
Furo
](
https://pradyunsg.me/furo/
)
-
[
numpydoc
](
https://numpydoc.readthedocs.io/
)
-
[
numpydoc
](
https://numpydoc.readthedocs.io/
)
...
@@ -104,7 +104,7 @@ In `B-ASIC`:
...
@@ -104,7 +104,7 @@ In `B-ASIC`:
```
bash
```
bash
python3
-m
venv
env
python3
-m
venv
env
source env
/bin/activate
source env
/bin/activate
pip
install
.
pip
install
.
[test]
pytest
pytest
```
```
...
@@ -115,7 +115,7 @@ In `B-ASIC` (as admin):
...
@@ -115,7 +115,7 @@ In `B-ASIC` (as admin):
```
bash
```
bash
python3
-m
venv
env
python3
-m
venv
env
.
\e
nv
\S
cripts
\a
ctivate.bat
.
\e
nv
\S
cripts
\a
ctivate.bat
pip
install
.
pip
install
.
[test]
pytest
pytest
```
```
...
@@ -155,7 +155,13 @@ How to build and use the library as a user.
...
@@ -155,7 +155,13 @@ How to build and use the library as a user.
### Installation
### Installation
```
bash
```
bash
pip
install
.
pip
install
.[pyqt6]
```
or
```
bash
pip
install
.[pyside6]
```
```
### Importing
### Importing
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment