Skip to content
Snippets Groups Projects

Update README.

Merged Jens Lucht requested to merge update-readme into master
1 file
+ 20
8
Compare changes
  • Side-by-side
  • Inline
+ 20
8
@@ -2,16 +2,28 @@ HoToPy - HoloTomoToolbox for Python
# HoToPy
Holotomotoolbox in Python
HoloTomotoolbox in Python (more holography currently).
## Installation
Install with (you may need the `--user` flag)
You need at least Python 3.7. Older versions may work but are not tested.
Install with (you may need the `--user` flag).
```
pip3 install git+ssh://git@gitlab.gwdg.de/irp/hotopy.git
pip3 install git+ssh://git@gitlab.gwdg.de/irp/hotopy.git [--user]
```
or list `git+ssh://git@gitlab.gwdg.de/irp/hotopy.git` in your requirements/dependencies.
### Upgrade
Install the latest version with
```commandline
pip3 install --upgrade --upgrade-strategy only-if-needed --no-cache-dir [--user]
```
or similar command depending on your installation method.
## Documentation
https://irp.pages.gwdg.de/hotopy/
@@ -61,9 +73,9 @@ Only when you know what you are doing and are certain not to break anything, sma
If you wish to build the documentation locally (as html for example), follow this steps.
0. Active the corresponding venv, if neede,
1. Install the requirements, see above. I.e. with `.[docs]` at least
2. Change into the `doc` directory; `cd doc`
3. Generate the HTML files with `make html`
4. *Optional*: Run a local HTTP server to access the documentation through a browser with
1. Active the corresponding venv, if needed,
2. Install the requirements, see above. I.e. with `.[docs]` at least
3. Change into the `doc` directory; `cd doc`
4. Generate the HTML files with `make html`
5. *Optional*: Run a local HTTP server to access the documentation through a browser with
`python3 -m http.server 14242 -d build/html --bind '::'`. You can access it at [http://localhost:14242](http://localhost:14242)
Loading