@@ -16,29 +16,33 @@ git clone https://github.com/open-pulse/OpenPulse.git
1616
1717# Running from source
1818
19- ## Poetry
20- The dependencies and environments in this project are managed mainly using Poetry .
21- If you do not have poetry installed, you can install it running:
19+ ## uv
20+ The dependencies and environments in this project are managed mainly using uv .
21+ If you do not have uv installed, you can install it running:
2222```
23- pip install poetry
23+ curl -LsSf https://astral.sh/uv/install.sh | sh
24+ ```
25+ Or on Windows:
26+ ```
27+ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
2428```
2529
2630To download and install all dependencies in a local environment run:
2731```
28- poetry install
32+ uv sync
2933```
30- This command is also usefull to reinstall the packages if some dependency changed.
34+ This command is also useful to reinstall the packages if some dependency changed.
3135
32- When the dependencies are installed in a local virtual environment poetry can run commands
36+ When the dependencies are installed in a local virtual environment uv can run commands
3337inside this environment as follows:
3438```
35- poetry run <you command here>
39+ uv run <your command here>
3640```
3741For example, to run VIBRA the following command is required:
3842```
39- poetry run python -m vibra
43+ uv run python -m vibra
4044```
41- For more information check out [ poetry documentation] ( https://python-poetry.org/docs / ) .
45+ For more information check out [ uv documentation] ( https://docs.astral.sh/uv / ) .
4246
4347
4448## Conda forge
@@ -47,7 +51,7 @@ only available through repositories such as conda forge.
4751
4852Download and install [ conda-forge] ( https://conda-forge.org/download/ ) .
4953It is recommended to check the option * Add Miniforge3 to my PATH environment variable* in the program installation setup.
50- Once conda-forge was installed, it is possible to enable the MUMPS solver in Vibra. To enable this solver we need to use conda instead of poetry .
54+ Once conda-forge was installed, it is possible to enable the MUMPS solver in Vibra. To enable this solver we need to use conda instead of uv .
5155To generate the conda environment, just run:
5256```
5357conda env create -f environment.yml
@@ -82,23 +86,23 @@ Broader tests, that depend on the interpretation of the developer, are located i
8286
8387To run automated tests execute:
8488```
85- poetry run pytest
89+ uv run pytest
8690```
8791For more information check out [ pytest documentation] ( https://docs.pytest.org/en/stable/ ) .
8892
8993# Interface compilation
9094The interfaces depend on ` .ui ` files that are created using Qt Designer.
9195Qt Designer is a tool that is installed with PySide6, and can be started with:
9296```
93- poetry run pyside6-designer
97+ uv run pyside6-designer
9498```
9599
96100After the ` .ui ` files are created they are compiled to ` *_UI.py ` files containing the classes
97101that represent each QWidget. These classes can be then specialized inside the software.
98102
99103The compilation process is executed with:
100104```
101- poetry run invoke ui-compile
105+ uv run invoke ui-compile
102106```
103107
104108
@@ -109,7 +113,7 @@ Pyinstaller is used to create executables.
109113In linux run the following command to create a folder containing
110114a executable and its dependencies.
111115```
112- poetry run pyinstaller vibra.spec --no-confirm
116+ uv run pyinstaller vibra.spec --no-confirm
113117```
114118
115119## Windows
@@ -124,7 +128,7 @@ You may also need to add it to your Windows path.
124128Given that InnoSetup is correctly installed and set to path,
125129to create a installer in windows run:
126130```
127- poetry run pyinstaller vibra.spec --noconfirm
131+ uv run pyinstaller vibra.spec --noconfirm
128132ISCC.exe /O"dist" /F"vibra-setup" "vibra.iss"
129133```
130134This process might take a while, but in the end your installer will appear inside the ` dist ` folder, named as ` open-pulse-setup-x64 ` .
0 commit comments