matisse 0.8.0

Modern and modular MATISSE interferometric data-reduction pipeline python interface. Developed by the MATISSE Consortium. It provides a user-friendly command-line interface (matisse) as well as backward compatibility with the original consortium scripts located in legacy/.

🚀 Installation (Users)

Recommended for end-users who only need to use the pipeline.

This project uses uv to manage environments and dependencies. It’s fully compatible with pip but much faster and simpler to use.

1️⃣ Install uv

On Linux / macOS:

curl -LsSf https://astral.sh/uv/install.sh | sh

2️⃣ Create and activate a virtual environment

uv venv --python 3.14 <my-matisse-env>
source <my-matisse-env>/bin/activate

3️⃣ Install the package

uv pip install matisse

⚡ Quick Start

A complete step-by-step guide is available here: docs/workflow-tutorial.md

🤝 Contributing

We welcome contributions from the Matisse Consortium and the wider community! A detailed procedure on how to set up your environment, follow our coding standards, and submit a Pull Request can be found in our Contributing Guide.

🧰 Legacy Scripts Compatibility

The original MATISSE reduction tools (mat_autoPipeline.py, etc.) are preserved in the legacy/ folder for full backward compatibility. They can be accessed by adding the legacy path to your environment:

export PATH="$PATH:$(python -c 'import matisse, pathlib; print(pathlib.Path(matisse.__file__).parent / "legacy")')"

You can add this line to your ~/.zshrc or ~/.bashrc to make it persistent.

Once exported, the commands will be available globally, e.g.:

mat_autoPipeline.py --dirCalib=.

🧩 Repository Structure

matisse-pipeline/
├── src/matisse/
│   ├── cli/                  # Main CLI entry point (`matisse`)
│   ├── legacy/               # Legacy MATISSE reduction scripts
│   ├── core/                 # Core pipeline modules
│   └── viewer/               # Viewer interface
├── tests/                    # Unit tests
├── docs/                     # Documentations
├── pyproject.toml            # Project configuration
├── CHANGELOG.md              # Project follow-up and versioning
└── README.md

🧑‍🔬 Citation / Credits

If you use this pipeline in your research, please cite the MATISSE Consortium and the corresponding instrument papers.

Maintained by the MATISSE Consortium Contributions welcome via pull requests.