Skip to content
Snippets Groups Projects
Commit e3a4aa7d authored by Tobias Hangleiter's avatar Tobias Hangleiter
Browse files

Merge branch '12-pip-deprecation' into 'master'

Resolve "pip deprecation"

Closes #12

See merge request !173
parents 48aa157f 81ff47cb
Branches
Tags
1 merge request!173Resolve "pip deprecation"
......@@ -15,12 +15,12 @@ python -m pip install qutech-util[complete]
However, this package profits from everybody's work and the releases are infrequent. Please make a development install
and contribute your changes. You can do this via
```sh
python -m pip install -e git+https://git.rwth-aachen.de/qutech/qutil.git#egg=qutech-util[complete]
python -m pip install -e git+https://git.rwth-aachen.de/qutech/qutil.git#egg=qutech-util
```
This will download the source code (i.e. clone the git repository) into a subdirectory of the `./src` argument and link the files into your environment instead of copying them. If you are on windows you can use [SourceTree](https://www.sourcetreeapp.com/) which is a nice GUI for git.
This will download the source code (i.e. clone the git repository) into a subdirectory of the `./src` argument and link the files into your environment instead of copying them. If you are on windows you can use [SourceTree](https://www.sourcetreeapp.com/) which is a nice GUI for git. Note that this will not install the `complete` extras and will also not work with `uv`.
You can specify the source code directory with the `--src` argument (which needs to be BEFORE `-e`):
```sh
python -m pip install --src some_directory/my_python_source -e git+https://git.rwth-aachen.de/qutech/qutil.git#egg=qutech-util[complete]
python -m pip install --src some_directory/my_python_source -e git+https://git.rwth-aachen.de/qutech/qutil.git#egg=qutech-util
```
If you have already downloaded/cloned the package yourself you can use `python -m pip install -e .[complete]`.
......@@ -29,7 +29,7 @@ Please file an issue if any of these instructions does not work.
## Tests
Except for the `plotting.live_view` module, there is no plan for writing extensive tests for the code in this package but please try to write proper docstrings for
your functions and include examples in them which can be checked via [`doctest`](https://docs.python.org/3/library/doctest.html).
Follow the link for an example for an example :)
Follow the link for an example :)
You can run the tests either via
```sh
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment