Metadata-Version: 2.5
Name: xmcd
Version: 0.4.0
Summary: Procedural Mathcad XML worksheets without Mathcad or COM
Project-URL: Homepage, https://github.com/nickadminroot/xmcd
Project-URL: Repository, https://github.com/nickadminroot/xmcd
Project-URL: Issues, https://github.com/nickadminroot/xmcd/issues
Author: nickadminroot
License: MIT License
        
        Copyright (c) 2026 nickadminroot
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: mathcad,scientific-computing,xmcd,xml
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.11
Requires-Dist: lxml>=6.1.3
Description-Content-Type: text/markdown

# xmcd

Python-библиотека для создания документов Mathcad XML (XMCD) без установленного Mathcad и Windows COM.

Объектная модель выражений, регионов и листов. Целевой формат: классический Mathcad, не Mathcad Prime MCDX.

Версия 0.4: формулы, матрицы, программы, решающие блоки, редактируемые XY- и полярные графики. [Покрытие и проверка](docs/compatibility.md) отделяют реализованные возможности от подтверждённых в Mathcad.

## Использование

```bash
uv sync
uv run python examples/core.py
uv run pytest -q
```

```python
from xmcd import Worksheet, Symbol, Function, Matrix, Integral

x = Symbol("x")
sheet = Worksheet("Расчёт")
sheet.text("Пример расчёта", top=24)
g = Function(Symbol("g"), [x])
sheet.define(g, x**3 + 2*x)
sheet.evaluate(g(2))
sheet.define(Symbol("M"), Matrix([[1, 2], [3, 4]]))
sheet.evaluate(Integral(x**2, x, 0, 1))
sheet.write("example.xmcd")
```

API использует явные объекты: `Symbol`, `Number`, `String`, `Function`, `Matrix`, `BuiltinFunction`. Настройки и операции имеют перечисления: `SolverKind`, `OperatorKind`, `DefinitionKind`, `MatrixStyle`, `LineStyle`, `Marker`. `Greek` задаёт греческие буквы, `LiteralSubscript` — буквенный индекс. Числовой индекс массива задаётся `A[i, j]`. Строки в позициях выражений и вместо перечислений не принимаются; используйте `Symbol("x")` для имени и `String("текст")` для строкового значения. Числовые литералы поддерживаются. Примеры — в [справочнике API](docs/api.md).

Высота формул, матриц и текста оценивается автоматически с запасом. Последовательные регионы размещаются ниже предыдущего; для графиков резервируется место под подписи. Можно явно задать `top` и `height`. Для результатов по диапазону и явных таблиц резервируется минимум 20 строк; запас настраивается через `ResultFormat(table_min_rows=30)`. Размер вычисляемой матрицы определяется по известным определениям; если он неизвестен без пересчёта, передайте `result_shape=ResultShape(rows, columns)`. См. [правила размещения](docs/layout.md) и `examples/layout.py`.

`Worksheet.write()` автоматически проверяет документ до записи: доступность имён, аргументы функций, известные размеры и индексы матриц, ряд числовых ошибок и совместимость известных единиц. `sheet.check()` возвращает диагностику; ошибки вызывают `WorksheetValidationError`. Сходимость и произвольные вычисления требуют Mathcad. [Проверки, строгий режим и ограничения](docs/validation.md).

`Worksheet.read(path)` загружает XMCD для изменения через классы и сохранения. `sheet.reflow()` заново расставляет прочитанные регионы. Импортированные графики и неизвестные элементы сохраняются как непрозрачные объекты. [Чтение, редактирование и ограничения](docs/reading.md).

Решающие блоки: `Given()` и `Solver(SolverKind.FIND)(x, y)`, пример `examples/solvers.py`. Редактируемые графики: `Trace`, `XYPlot` и `sheet.plot(...)`; [примеры и ограничения](docs/plot-format.md).

[Справочник Python API](docs/api.md) · [Карта покрытия страниц книги](docs/book-coverage.md).

## Установка пакета

После публикации пакет устанавливается из PyPI:

```bash
python -m pip install xmcd
```

Для разработки из исходного дерева:

```bash
uv build
uv pip install dist/xmcd-0.4.0-py3-none-any.whl
```

Пакет не обращается к Windows, Mathcad или COM. Для вычисления формул полученный файл открывается в классическом Mathcad. Проверенная версия — 14.1.5.594; совместимость с другими версиями требует отдельного тестирования.

Связанные расчёты: `examples/compressor.py` и `examples/cam.py`. Остальные примеры показывают отдельные группы API. Сгенерированные файлы записываются в `output/`; пересчитанные образцы для регрессии находятся в `tests/fixtures/`.

Исходный код и история изменений: [github.com/nickadminroot/xmcd](https://github.com/nickadminroot/xmcd).
