Metadata-Version: 2.4
Name: ras-code
Version: 0.1.0
Summary: Modular ecosystem to automate and extend HEC-RAS to your heart's content.
Requires-Python: >=3.13
Description-Content-Type: text/markdown
Requires-Dist: rasmatazz>=0.1.1
Requires-Dist: ras-commander==0.99.1

# RAS-Code ecosystem

Modular ecosystem to automate and extend HEC-RAS to your heart's content.

RAS-Code is a metadata-only package: it contains no importable code of its
own. Add it once to install the complete ecosystem and its dependencies.

## Installation

Add RAS-Code to a uv-managed project:

```shell
uv add ras-code
```

Or install it into the active environment:

```shell
uv pip install ras-code
# or
pip install ras-code
```

RAS Commander is pinned to `0.99.1` so a future Commander release cannot
silently break a working RAS-Code environment.

Package managers treat declared dependencies as mandatory. If Commander is
unavailable on your system and you want to continue with the core ecosystem,
use this best-effort fallback:

```shell
uv add ras-code || {
    echo 'WARNING: RAS Commander could not be installed; continuing with RASmatazz only.'
    uv add rasmatazz
}
```

For pip-managed environments:

```shell
pip install ras-code || {
    echo 'WARNING: RAS Commander could not be installed; continuing with RASmatazz only.'
    pip install rasmatazz
}
```

## Included projects

### RASmatazz

The Swiss Army knife at the center of the ecosystem. RASmatazz provides
composable tools for working directly with HEC-RAS projects and their related
text, spatial, HDF5, DSS, and RAS Mapper data.

### RAS Commander

Automation tools for HEC-RAS projects, plans, geometry, unsteady flow, model
execution, and results. RAS-Code installs the tested `0.99.1` release.

### SHPshifter

Extends the GeoPandas and rioxarray stack, helping replace desktop GIS
workflows with pure Python.

### funkshuns

Shared general-purpose utilities used throughout the ecosystem.

### TXTure

Intuitive tools for reading, finding, and surgically editing structured,
machine-readable ASCII files such as HEC-RAS project inputs.

### DSSence

A Swiss Army knife for working with HEC-DSS files. DSSence and its DSS tooling
are installed on Windows through RASmatazz's platform-specific dependencies.

## License

Free software under the MIT license.
