Skip to content
Open
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
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
# These owners will be requested for review when someone opens a pull request.
* @forrestfwilliams
* @Alex-Lewandowski
* @jhkennedy
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ jobs:
develop_branch: develop
sync_pr_label: actions-bot
secrets:
USER_TOKEN: ${{ secrets.FORREST_BOT_PAK }}
USER_TOKEN: ${{ secrets.MULTISAR_BOT_PAK }}
6 changes: 3 additions & 3 deletions .github/workflows/tag-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
# Docs: https://github.com/ASFHyP3/actions
uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.21.0
with:
user: forrest-bot
email: ffwilliams2@alaska.edu
user: multisar-bot
email: forrestfwilliams@icloud.com
secrets:
USER_TOKEN: ${{ secrets.FORREST_BOT_PAK }}
USER_TOKEN: ${{ secrets.MULTISAR_BOT_PAK }}
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ 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.5.5]

### Changed
* Transferred project to the new MultiSAR organization to simplify collaboration.
* Updated links and CI/CD for transfer.

## [0.5.4]

### Fixed
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Below is a list of relevant SAR data sources and their support status:

I have done my best to accurately reflect the support status of each SAR image type, but please let me know if I have made any mistakes. Note that some commercial datasets used to use polar instead of range doppler image grids for specific images modes. This table is based on the image grid types currently being used.

\*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.
\*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/multisar/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.

## Usage

Expand Down Expand Up @@ -61,7 +61,7 @@ docker run -it --rm \
-e EARTHDATA_USERNAME=YOUR_USERNAME_HERE \
-e EARTHDATA_PASSWORD=YOUR_PASSWORD_HERE \
-v ~/LOCAL_PATH/PROJECT:/home/conda/PROJECT \
ghcr.io/forrestfwilliams/multirtc:VERSION.pfa \
ghcr.io/multisar/multirtc:VERSION.pfa \
rtc PLATFORM SLC-GRANULE --resolution RESOLUTION --work-dir PROJECT
```
The local `project1` directory can be a name of your choosing and should have the structure:
Expand Down Expand Up @@ -145,19 +145,19 @@ See `multirtc pt --help` for descriptions of each argument.
## When will support for [insert SAR provider here] products be added?
We're currently working on this package on a "best effort" basis with no specific timeline for any particular dataset. We would love to add support for every SAR dataset ASAP, but we only have so much time to devote to this package. If you want a particular dataset to be prioritized there are several things you can do:

- [Open an issue](https://github.com/forrestfwilliams/multirtc/issues/new) requesting support for your dataset and encourage others to like or comment on it.
- [Open an issue](https://github.com/multisar/multirtc/issues/new) requesting support for your dataset and encourage others to like or comment on it.
- Provides links to example datasets over the Rosamond, California corner reflector site (Lat/Lon 34.799,-118.095) for performing cal/val.
- Reach out to us about funding the development required to add your dataset.

## Developer Setup
1. Ensure that conda is installed on your system (we recommend using [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) to reduce setup times).
2. Download a local version of the `multirtc` repository (`git clone https://github.com/forrestfwilliams/multirtc.git`)
2. Download a local version of the `multirtc` repository (`git clone https://github.com/multisar/multirtc.git`)
3. In the base directory for this project call `mamba env create -f environment.yml` to create your Python environment, then activate it (`mamba activate multirtc`)
4. Finally, install a development version of the package (`python -m pip install -e .`)

To run all commands in sequence use:
```bash
git clone https://github.com/forrestfwilliams/multirtc.git
git clone https://github.com/multisar/multirtc.git
cd multirtc
mamba env create -f environment.yml
mamba activate multirtc
Expand All @@ -179,4 +179,4 @@ Contributions to this project plugin are welcome! If you would like to contribut
Want to talk about this project? We would love to hear from you!

Found a bug? Want to request a feature?
[open an issue](https://github.com/forrestfwilliams/multirtc/issues/new)
[open an issue](https://github.com/multisar/multirtc/issues/new)
7 changes: 4 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ build-backend = "setuptools.build_meta"
name = "multirtc"
requires-python = ">=3.10"
authors = [
{name="Forrest Williams", email="ffwilliams2@alaska.edu"},
{name="Forrest Williams", email="forrestfwilliams@icloud.com"},
# Add names as preferred
]
description = "Python library for multi-sensor RTC processing using the OPERA algorithm"
license = {text = "BSD-3-Clause"}
Expand Down Expand Up @@ -45,8 +46,8 @@ dynamic = ["version", "readme"]
develop = ["pytest", "pytest-cov", "pytest-console-scripts", "ruff"]

[project.urls]
Homepage = "https://github.com/forrestfwilliams/multirtc"
Documentation = "https://github.com/forrestfwilliams/multirtc"
Homepage = "https://github.com/multisar/multirtc"
Documentation = "https://github.com/multisar/multirtc"

[project.scripts]
multirtc = "multirtc.__main__:main"
Expand Down
2 changes: 1 addition & 1 deletion src/multirtc/multirtc.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def run_multirtc(
else:
raise NotImplementedError(
'RTC creation is not supported for this input. For polar grid support, use the multirtc docker image:\n'
'https://github.com/forrestfwilliams/MultiRTC/pkgs/container/multirtc'
'https://github.com/MultiSAR/MultiRTC/pkgs/container/multirtc'
)


Expand Down
Loading