Metadata-Version: 2.4
Name: uarc-simulator
Version: 0.3.0
Summary: UARC desktop host and RocketPy simulation engine
Keywords: rocket,simulation,rocketpy,desktop
Author: Park Changyeong
Author-email: Park Changyeong <amuileum07@gmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Dist: certifi>=2026.7.22
Requires-Dist: defusedxml>=0.7.1
Requires-Dist: numpy>=2.5.3
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pydantic>=2.13.5
Requires-Dist: pywebview==6.2.1 ; sys_platform != 'linux'
Requires-Dist: pywebview[pyside6]==6.2.1 ; sys_platform == 'linux'
Requires-Dist: pyside6==6.11.2 ; sys_platform == 'linux'
Requires-Dist: rasterio==1.4.4
Requires-Dist: rocketpy==1.13.0
Requires-Dist: scipy>=1.13.0
Requires-Dist: tzdata>=2026.6
Requires-Python: >=3.13, <3.14
Project-URL: Homepage, https://github.com/amuileum07/UARC
Project-URL: Documentation, https://github.com/amuileum07/UARC/blob/main/docs/PACKAGING.md
Project-URL: Issues, https://github.com/amuileum07/UARC/issues
Description-Content-Type: text/markdown

# UARC simulator

UARC is a desktop rocket simulator for AERO, UNIST's undergraduate rocket club.
It combines a React interface, 2D/3D rocket previews, terrain maps and RocketPy
flight calculations. The Python distribution is **uarc-simulator**; the commands
are **uarc** and **uarc-data**. The unrelated PyPI project named `uarc` is not this
application.

Python **3.13.x** and a graphical desktop are required. Other Python minor
versions are not yet supported by the tested native dependency/build combination.
Supported platforms are Windows x64, Linux x64 and macOS Apple Silicon.
Intel Macs are not currently supported.
The published wheel and source distribution include the built interface,
starting designs, material
catalogue and documentation. Node.js and pnpm are not needed to run an installed
distribution.

## Install and run

Choose one installation method:

```bash
# pip, inside a Python 3.13 virtual environment
python -m pip install uarc-simulator
uarc

# pipx, using a Python 3.13 interpreter
pipx install --python 3.13 uarc-simulator
uarc

# uv persistent tool installation
uv tool install --python 3.13 uarc-simulator
uarc

# uvx: temporary isolated environment
uvx --python 3.13 --from uarc-simulator uarc
```

For one-off pipx execution, use `pipx run --python 3.13 --spec uarc-simulator uarc`.
Use `uarc --help` or `uarc-data --help` for available options. The same launcher
supports `uarc --simulate design.uarc --design` and `uarc --data --help` without
opening a window.

OS webview/graphics dependencies still apply. Windows offers missing/old WebView2
and .NET prerequisites for installation after consent; its setup window needs
Python's Tcl/Tk support. Linux uses PySide6/Qt and the system graphics libraries.
WebView2 107+ is needed for the frontend's browser features.
macOS uses the native WebKit webview; the pinned rasterio wheels require macOS
14+ on Apple Silicon. Python-free executable downloads are also
provided through [GitHub Releases](https://github.com/amuileum07/UARC/releases).

PyPI installers resolve dependency declarations rather than `uv.lock`.
RocketPy is pinned to 1.13.0 because the terrain-contact adapter is version-bound.
If installation tries to build rasterio and asks for GDAL, check the Python
version and architecture first; the supported wheels include GDAL.
Aerodynamic coefficients remain preliminary engineering estimates, with
component-specific verification limits.

See [documentation](https://github.com/amuileum07/UARC/tree/main/docs),
[aerodynamic verification](https://github.com/amuileum07/UARC/blob/main/docs/AERODYNAMICS.md),
and [source](https://github.com/amuileum07/UARC). Licensed under MIT; bundled
third-party notices are included with the package assets.
