NetMotif

Local Development Setup

Note: This application is currently supported only on Linux and macOS systems. Please ensure you are using a Linux or macOS environment to run the app and the appropiate lalbeg binary for each platform.

Follow the steps below to set up the project for local development:

1. Clone the Repository

Start by cloning this repository to your local machine:

git clone https://github.com/your-username/your-repo.git
cd your-repo

2. Create and Activate a Virtual Environment

The project was testes with python 3.14, but any python version supported by the streamlit framework should work.

# Set up .venv if haven't yet
$ python -m venv .venv

# On MacOS and Linux.
$ source .venv/bin/activate

# On Windows.
$ .venv\Scripts\activate

3. Install Project Dependencies

pip install -r requirements.txt

4. Run the Streamlit App

streamlit run app.py

This will launch the app, and you can access it by navigating to http://localhost:8501 in your browser.

5. Run Tests

python -m pytest test

To generate new snapshots (if a bug is fixed or a new test is added), run:

python -m pytest test --snapshot-update

Project Directory

├── app.py    # main entry used by streamlit to activate app
├── data/     # contains graph input examples
├── drawings/ # contains generated graphs, no need to be touched
├── labelg    # labelg C program (platform-dependent binary)
├── lib/      # contains code auto generated by pyvis, no need to be touched
├── out/      # contains canonical output
├── src/      # contains scripts for the program
├── test/     # contains test files

References

Graph6 and Digraph6 format: https://users.cecs.anu.edu.au/~bdm/data/formats.txt