Updated global readme

This commit is contained in:
Dmitriy Shishkov 2023-10-29 19:17:43 +03:00
parent 59bb5d901f
commit c1f573298e
Signed by: dm1sh
GPG Key ID: 027994B0AA357688

View File

@ -1,22 +1,60 @@
# PyQT graph plotter
## Package interface
## Интерфейс пакетов
- `graph_widget`
<Артёмка>
- `parser`
[parser/README.md](./parser/README.md)
- `plotter_dialog`
```python
from plotter_dialog import PlotterDialog
from plotter_dialog import PlotterDialog, FUNCTION_NAMES
PlotterDialog(
variable_full_names: dict[str, str] # Variable button and tooltip captions
function_full_names: dict[str, str] # Same for function
variable_values: dict[str, numpy.ndarray] # Values to be substituted for variables
variable_values: dict[str, np.ndarray] = {} # Значения для подстановки в переменные
variable_full_names: dict[str, str] = {} # Надписи для кнопок переменных и подсказок для них
function_full_names: dict[str, str] = FUNCTION_NAMES # То же самое для функций
)
FUNCTION_NAMES = {
"abs": "Модуль",
"acos": "Арккосинус",
"acosh": "Гиперболический арккосинус",
"acot": "Арккотангенс",
"asin": "Арксинус",
"asinh": "Гиперболический арксинус",
"atan": "Арктангенс",
"avg": "Среднее",
"cos": "Косинус",
"cosh": "Гиперболический косинус",
"cot": "Котангенс",
"exp": "Экспонента (e^x)",
"lg": "Десятичный логарифм",
"ln": "Натуральный логарифм",
"log2": "Двоичный логарифм",
"max": "Максимум",
"min": "Минимум",
"prod": "Произведение",
"sgn": "Знак",
"sin": "Синус",
"sinh": "Гиперболический синус",
"sqrt": "Квадратный корень",
"sum": "Сумма",
"tanh": "Гиперболический тангенс",
"tan": "Тангенс",
}
```
`variable_full_names` and `variable_values` must have same keys.
`variable_full_names` и `variable_values` должны иметь одни и те же ключи.
## Demo running instructions
## Инструкции по запуску демо-версии
Run in project root directory:
Выполнить в корневой папке:
```bash
python -m venv .venv