Skip to content
Snippets Groups Projects
Commit 4fe269f5 authored by Simon Bjurek's avatar Simon Bjurek
Browse files

updated readme

parent c3b22def
No related branches found
No related tags found
1 merge request!463Removed requirement txt files and added optional dependencies instead.
Pipeline #155565 passed
...@@ -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
.\env\Scripts\activate.bat .\env\Scripts\activate.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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment