rmtoo

Installation Guide

This section covers installing rmToo on different operating systems.

Choose Your Platform

🐧 Linux

Fully supported - Complete installation guide for major Linux distributions including Ubuntu, CentOS, Fedora, openSUSE, and Arch Linux.

🍎 macOS

Community supported - Installation guide using macports. Some users have reported success, but this is not officially supported.

🪟 Windows

Community supported - Installation guide using Cygwin or WSL. Tested but not officially supported.

Quick Start

For most users, the recommended approach is:

1. Install Python 3.9+ and system dependencies for your platform
2. Create a virtual environment:

   python3 -m venv rmtoo-env
   source rmtoo-env/bin/activate  # On Windows: rmtoo-env\Scripts\activate
   

3. Install rmToo:

   pip install rmtoo
   

4. Create your first project:

   cp -r "$(rmtoo-contrib-dir)/template_project" MyProject
   cd MyProject
   source ./setenv.sh VENV
   make
   

Dependencies

Required

• Python 3.9+ - Core runtime
• LaTeX - For PDF output generation
• Graphviz - For dependency graphs

Optional

• NumPy/SciPy - For statistical analysis
• Gnuplot - For statistical plots
• Git - For version control integration

Installation Methods

Package Manager (Recommended)

pip install rmtoo

Development Installation

git clone https://github.com/florath/rmtoo.git
cd rmtoo
pip install -e .

Virtual Environment (Recommended)

python3 -m venv venv
source venv/bin/activate
pip install rmtoo

Verification

After installation, verify rmToo is working:

rmtoo --help
rmtoo-contrib-dir

Next Steps

After installation:

1. Read the Getting Started guide
2. Learn about Requirements vs Constraints

Troubleshooting

If you encounter issues:

• Check the platform-specific installation guide
• Review the FAQ
• Report issues on GitHub

This site is open source. Improve this page.