[Visualizer] .railtracks folder location #1024

Issue Type

Bug/Error

Description

I noticed a potentially problematic issue with how we are storing the json files. Let's say the user has ran pip install railtracks[cli] and they have the following folder structure:

project-root/
├── agent_1.py
├── first_folder/
│   └── agent_2.py
└── venv/

if they run either agent from project-root, by running python agent_1.py and python first_folder/agent_2.py, their directory will look like this:

project-root/
├── .railtracks/
├── agent_1.py
├── first_folder/
│   └── agent_2.py
└── venv/

However, if they run either agent from within first_folder by running python ../agent_1.py and python agent_2.py, then their directory will look like this:

project-root/
├── agent_1.py
├── first_folder/
│   ├── .railtracks/
│   └── agent_2.py
└── venv/

What if they'd done both throughout their dev cycle? Then they'll have this:

project-root/
├── .railtracks/
├── agent_1.py
├── first_folder/
│   ├── .railtracks/
│   └── agent_2.py
└── venv/

And if we're being honest, it's highly likely developers are not paying attention on the directory they're running their python scripts from.

So what happens now? Some of their data will be in project-root/.railtracks and some of it will be in project-root/first_folder/.railtracks and the visualizer will also behave similarly based on where railtracks init is run. This has the potential to cause significant confusion for the users.

The only way I can see of addressing this is to require RAILTRACKS_HOME to be set by the users for one unified location for storage.

cc: @jbueza-railtownai @soulFood5632