|
|
|
## Getting Started
|
|
|
|
|
|
|
|
This documentation assumes you already have or know how to install a new python3
|
|
|
|
environment on your local machine. If it is not yet the case, We suggest to check
|
|
|
|
[this](https://www.anaconda.com/) out.
|
|
|
|
|
|
|
|
Currently the main dependencies of this module are:
|
|
|
|
|
|
|
|
- scipy
|
|
|
|
- numpy
|
|
|
|
- pandas
|
|
|
|
- pandas-stubs
|
|
|
|
- lark
|
|
|
|
- more-itertools
|
|
|
|
|
|
|
|
For JupyterLab user, think to also install (to have nice progressbar):
|
|
|
|
|
|
|
|
- tqdm
|
|
|
|
- jupyterlab-widgets
|
|
|
|
- ipywidgets
|
|
|
|
|
|
|
|
## Remarks for developer
|
|
|
|
|
|
|
|
If you intend to join this dev. adventure, first of all, thank you for your time and
|
|
|
|
support. Second, please be aware that this code base uses the fast
|
|
|
|
[RUFF](https://github.com/astral-sh/ruff) linter and comply with the
|
|
|
|
[Mypy](https://mypy.readthedocs.io/en/stable/index.html) static type checker.
|
|
|
|
|
|
|
|
ps: Needless to say that Python2 is forbidden...
|
|
|
|
pps: There is currently no code coverage (tests)... a big problem to solve. |
|
|
\ No newline at end of file |
