Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.6.0]

### Changed
* Pixi is now used in place of Conda for installation and depedency management

## [0.5.4]

### Fixed
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,29 @@ I have done my best to accurately reflect the support status of each SAR image t

\*Polar image grid support is implemented via the [approach detailed by Piyush Agram](https://arxiv.org/abs/2503.07889v1) in his recent technical note. I have implemented his method in a fork of the main ISCE3 repo, which you can view [here](https://github.com/forrestfwilliams/isce3/tree/pfa). The long-term plan is to merge this into the main ISCE3 repo but until that is complete, polar grid support is only available via this project's `pfa`-suffixed docker containers. See the running via docker section for more details.

## Installation

1. Ensure that pixi is installed on your system: <https://pixi.sh/latest/installation/>.
2. Clone the `MultiRTC` repository and navigate to the root directory of this project
```bash
git clone https://github.com/ASFHyP3/MultiRTC.git
cd MultiRTC
```
3. setup the development environment
```bash
pixi run install-editable
```
4. (optional) [traditional conda-like activation](https://pixi.sh/latest/workspace/environment/#traditional-conda-activate-like-activation) of the pixi environment
```bash
eval "$(pixi shell-hook)"
```

> [!TIP]
> If you skip this, you'll need to prefix commands with `pixi run`.
5. (optional) Setup you IDE to work with pixi:
* PyCharm: https://pixi.sh/dev/integration/editor/jetbrains/
* VSCode: https://pixi.sh/dev/integration/editor/vscode/

## Usage

To create an RTC, use the `multirtc` CLI entrypoint using the following pattern:
Expand Down
36 changes: 0 additions & 36 deletions environment.yml

This file was deleted.

Loading