Skip to content

Commit

Permalink
chore(docs): some small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jeertmans committed Aug 10, 2023
1 parent b955287 commit 5e06129
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 7 deletions.
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
Differentiable Ray Tracing (RT) Python framework for Telecommunications-oriented applications.

> **NOTE**: the present work offers a simple Python module to create basic 2D scenarios,
> and should be used for experimental purposes.
> and should be used for experimental purposes only.
- [Installation](#installation)
* [Dependencies](#dependencies)
Expand All @@ -24,7 +24,9 @@ Differentiable Ray Tracing (RT) Python framework for Telecommunications-oriented

<!-- start install -->

While installing DiffeRT2D and its dependencies on your global Python is fine, I recommend using a virtual environment (e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.
While installing DiffeRT2D and its dependencies on your global Python is fine,
I recommend using a virtual environment
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.

### Dependencies

Expand All @@ -50,7 +52,7 @@ The recommended way to install the latest release is to use pip:
pip install differt2d
```

Optionally, you can also install its graphical user interface using extras[^1]:
Optionally, you can also install its graphical user interface using [extras](#package-extras):

```bash
pip install differt2d[gui]
Expand All @@ -66,14 +68,40 @@ read the
[contributing guide](https://eertmans.be/DiffeRT2d/contributing/workflow.html)
to know how.

### Package Extras

On top of the default features this package provides, you can optionally
install additional dependencies using *extras*:

```bash
pip install differt2d[extra]
```

where `extra` is the name of some additional features, or

```bash
pip install differt2d[extra1,extra2]
```

if you want to install multiple extras.

List of available extras:

+ **`examples`**: install required dependencies to run all the scripts in the
[examples](https://github.com/jeertmans/DiffeRT2d/tree/main/examples)
folder.
+ **`gui`**: W.I.P, do not use.


<!-- end install -->

## Usage

<!-- start usage -->

You may find a multitude of usage examples across the documentation
or the [examples](./examples/) folder.
or the [examples](https://github.com/jeertmans/DiffeRT2d/tree/main/examples)
folder.

<!-- end usage -->

Expand Down
2 changes: 1 addition & 1 deletion differt2d/optimize.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def default_optimizer() -> optax.GradientTransformation:
This optimizer should be a good default choise when used by
:class:`MinPath<differt2d.geometry.MinPath>` as it gave the
best convergence results when compared to other optimizers
provided by :mod:`optax`.
provided by `Optax <https://optax.readthedocs.io/>`_.
:return: The default optimizer.
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ build-backend = "poetry.core.masonry.api"
requires = ["poetry-core"]

[tool.black]
target-version = ["py38"]
target-version = ["py39"]

[tool.isort]
profile = "black"
py_version = 38
py_version = 39

[tool.poetry]
authors = ["Jérome Eertmans <jeertmans@icloud.com>"]
Expand Down

0 comments on commit 5e06129

Please sign in to comment.