Install & Configure

Requirements

• Python 3.10 or newer
• pip 21+ (or pipx, poetry, etc.)
• Optional: pandas and pyarrow if you plan to export large result sets

Create an environment

python3 -m venv ~/.venvs/rmap
source ~/.venvs/rmap/bin/activate
python -m pip install --upgrade pip

Virtual environments keep dependencies isolated from system packages. Feel free to use conda, pipenv, or any other environment manager that suits your workflow.

Install pyrmap

pip install pyrmap

Upgrade with pip install --upgrade pyrmap as new releases land.

Verify the installation

>>> import pyrmap
>>> pyrmap.__version__
'0.1.0'
>>> pyrmap.get_available_tgas()
['entropy', 'random', 'sixgen', 'sixforest', 'sixgraph', 'sixtree', 'det', 'sixprobe', 'sixgan', 'sixgcvae', 'sixveclm']

If import pyrmap fails, confirm the virtual environment is active and that no system-wide site packages shadow the module name.

You’re ready to explore the rest of the scripting guides once the interpreter can import pyrmap and list the available TGAs.