|
|
|
# 1. Requierements
|
|
|
|
|
|
|
|
## a) Windows
|
|
|
|
- Mingw-w64: https://www.mingw-w64.org/
|
|
|
|
- Python 3: https://www.python.org/downloads/release/python-3110/
|
|
|
|
|
|
|
|
## b) GNU/Linux
|
|
|
|
- build-essential
|
|
|
|
- Python 3
|
|
|
|
|
|
|
|
```
|
|
|
|
apt install buid-essential gcc python3
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
# 2. Compilation and Installation
|
|
|
|
|
|
|
|
To compile and install the package for a specific version of python (for example, Python 3.11), go to the project root directory and use the following commands:
|
|
|
|
|
|
|
|
## a) Windows (10 et 11)
|
|
|
|
```
|
|
|
|
py -3.11 setup.py bdist_wheel
|
|
|
|
py -3.11 -m pip install dist/qosm_core-0.1-cp311-cp311-win_amd64.whl --force-reinstall
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## b) GNU/Linux (Tested on Ubuntu)
|
|
|
|
```
|
|
|
|
python3 setup-linux.py bdist_wheel
|
|
|
|
python3 -m pip install dist/qosm_core-0.1-cp311-cp311-linux_x86_64.whl --force-reinstall
|
|
|
|
```
|
|
|
|
|
|
|
|
# 3. Import
|
|
|
|
|
|
|
|
You can now import the module and specific components.
|
|
|
|
Here is an example:
|
|
|
|
```
|
|
|
|
from qosm_core import VirtualSource, beam_tracing, Medium, Beam, Horn, Vec3, Quaternion
|
|
|
|
``` |
|
|
|
\ No newline at end of file |