Merge pull request #103 from SDNNetSim/release/5.5.1

Release/5.5.1

Author: ryanmccann1024

.github/workflows/cross_platform.yml

@@ -9,68 +9,45 @@ on:
       - main
 
 jobs:
-  test-windows:
-    name: Test on Windows 11
-    runs-on: windows-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.11
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          if (Test-Path requirements.txt) {
-            Get-Content requirements.txt | Where-Object {$_ -notmatch 'rl_zoo3|stable-baselines3|pip|triton'} | Set-Content filtered_requirements.txt
-            pip install -r filtered_requirements.txt
-          }
-
-      - name: Run Python script on Windows
-        run: |
-          python ./run_sim.py --config_path=ini/example_ini/cross_platform.ini
+  test:
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    name: Test on ${{ matrix.os }}
 
-  test-ubuntu:
-    name: Test on Ubuntu
-    runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: '3.11'
 
       - name: Install dependencies
+        shell: bash
         run: |
-          python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then sed -e '/rl_zoo3/d' -e '/stable-baselines3/d' -e '/triton/d' requirements.txt > filtered_requirements.txt; pip install -r filtered_requirements.txt; fi
-
-      - name: Run Python script on Ubuntu
-        run: |
-          python ./run_sim.py --config_path=ini/example_ini/cross_platform.ini
-
-  test-macos:
-    name: Test on MacOS
-    runs-on: macos-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.11
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then sed -e '/rl_zoo3/d' -e '/stable-baselines3/d' -e '/triton/d' requirements.txt > filtered_requirements.txt; pip install -r filtered_requirements.txt; fi
-
-      - name: Run Python script on MacOS
-        run: |
-          python ./run_sim.py --config_path=ini/example_ini/cross_platform.ini
+          # Step 1: Upgrade pip and install core build tools
+          python -m pip install --upgrade pip setuptools wheel
+          
+          # Step 2: Install torch first
+          pip install torch==2.2.2
+          
+          # Step 3: Install PyG packages with platform-specific logic
+          if [[ "${{ runner.os }}" == "macOS" ]]; then
+            # For macOS, compile from source with specific flags
+            echo "Applying macOS build flags..."
+            MACOSX_DEPLOYMENT_TARGET=10.15 pip install --no-build-isolation torch-scatter torch-sparse torch-cluster torch-spline-conv -f https://data.pyg.org/whl/torch-2.2.2+cpu.html
+          else
+            # For Linux/Windows, install from pre-built wheels
+            pip install torch-scatter torch-sparse torch-cluster torch-spline-conv -f https://data.pyg.org/whl/torch-2.2.2+cpu.html
+          fi
+          
+          # Step 4: Install the rest of the requirements
+          # Filter out all packages installed in previous steps, INCLUDING pip
+          grep -vE "torch-scatter|torch-sparse|torch-cluster|torch-spline-conv|torch|triton|pip" requirements.txt > other_requirements.txt
+          pip install -r other_requirements.txt
+
+      - name: Run Python script
+        run: python ./run_sim.py --config_path=ini/example_ini/cross_platform.ini

.github/workflows/unittests.yml

@@ -26,20 +26,31 @@ jobs:
         python-version: [ "3.11" ]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
+          # Step 1: Upgrade pip and install core build and testing tools
+          python -m pip install --upgrade pip setuptools wheel
           pip install flake8 pytest
-          if [ -f requirements.txt ]; then sed -e '/rl_zoo3/d' -e '/stable-baselines3/d' requirements.txt > filtered_requirements.txt; pip install -r filtered_requirements.txt; fi
+          
+          # Step 2: Install torch first
+          pip install torch==2.2.2
+          
+          # Step 3: Install PyG packages for Linux
+          pip install torch-scatter torch-sparse torch-cluster torch-spline-conv -f https://data.pyg.org/whl/torch-2.2.2+cpu.html
+          
+          # Step 4: Install the rest of the requirements from the original file
+          # This ensures stable-baselines3 and all other packages are installed
+          pip install -r requirements.txt
 
       - name: Print Current Working Directory
         run: pwd
 
       - name: Test with pytest
         run: |
-          pytest
+          pytest

README.md

@@ -1,57 +1,126 @@
-
 # Flexible Unified System for Intelligent Optical Networking (FUSION)
 
 ## About This Project
 
-Welcome to the FUSION, an open-source venture into the future of networking! Our core focus is on simulating Software Defined Elastic Optical Networks (SD-EONs), a cutting-edge approach that promises to revolutionize how data is transmitted over optical fibers. But that's just the beginning. We envision the SDN Simulator as a versatile simulation framework that can evolve to simulate a wide array of networking paradigms, now including the integration of artificial intelligence to enhance network optimization, performance, and decision-making processes.
+Welcome to **FUSION**, an open-source venture into the future of networking! Our core focus is on simulating **Software Defined Elastic Optical Networks (SD-EONs)**, a cutting-edge approach that promises to revolutionize how data is transmitted over optical fibers. But that's just the beginning. We envision FUSION as a versatile simulation framework that can evolve to simulate a wide array of networking paradigms, now including the integration of **artificial intelligence** to enhance network optimization, performance, and decision-making processes.
 
 We need your insight and creativity! The true strength of open-source lies in community collaboration. Join us in pioneering the networks of tomorrow by contributing your unique simulations and features. Your expertise in AI and networking can help shape the future of this field.
 
 ## Getting Started
 
 ### Supported Operating Systems
 
-- Ubuntu version 20.04+
+- macOS (requires manual compilation steps)
+- Ubuntu 20.04+
 - Fedora 37+
 - Windows 11
 
 ### Supported Programming Languages
 
-- Python version 3.11+
-
-### Installation
-
-To get started with the FUSION, follow these steps to set up your environment:
-
-1. Navigate to the desired directory you'd like to clone the repo to:
-   ```
-   cd /your/desired/path
-   ```
-2. Clone the repository:
-   ```
-   git clone git@github.com:SDNNetSim/FUSION.git
-   ```
-3. Change into the project directory:
-   ```
-   cd FUSION
-   ```
-4. Install the required dependencies:
-   ```
-   pip install -r requirements.txt
-   ```
-5. Navigate to the docs directory and generate the Sphinx documentation:
-
-   On Unix:
-   ```
-   cd docs
-   make html
-   ```
-   On Windows:
-   ```
-   cd docs
-   .\make html
-   ```
-6. Finally, navigate to `_build/html/` and open `index.html` in a browser of your choice to view the documentation.
+- Python 3.11.X
+
+---
+
+## Installation Instructions
+
+To get started with FUSION, first clone the repository and create a Python 3.11 virtual environment:
+
+```bash
+# Navigate to your desired directory
+cd /your/desired/path
+
+# Clone the repository
+git clone git@github.com:SDNNetSim/FUSION.git
+cd FUSION
+
+# Create and activate a Python 3.11 virtual environment
+python3.11 -m venv venv
+source venv/bin/activate
+```
+
+Next, follow the specific instructions for your operating system.
+
+---
+
+### macOS Installation
+
+Installation on macOS is a multi-step process that requires compiling packages from source. Please follow these steps carefully.
+
+**Step 1: Install Prerequisites**
+
+Ensure you have Apple’s Command Line Tools installed:
+
+```bash
+xcode-select --install
+```
+
+**Step 2: Install PyTorch**
+
+```bash
+pip install torch==2.2.2
+```
+
+**Step 3: Install PyTorch Geometric (PyG) Packages**
+
+These packages require special flags to compile correctly on macOS:
+
+```bash
+MACOSX_DEPLOYMENT_TARGET=10.15 pip install --no-build-isolation torch-scatter torch-sparse torch-cluster torch-spline-conv -f https://data.pyg.org/whl/torch-2.2.2+cpu.html
+```
+
+**Step 4: Install Remaining Dependencies**
+
+```bash
+pip install -r requirements.txt
+```
+
+---
+
+### Linux & Windows Installation
+
+Installation on Linux and Windows is more straightforward.
+
+**Step 1: Install PyTorch**
+
+```bash
+pip install torch==2.2.2
+```
+
+**Step 2: Install All Other Dependencies**
+
+```bash
+pip install -r requirements.txt
+```
+
+---
+
+## Generating the Documentation
+
+After installing the dependencies, you can generate the Sphinx documentation.
+
+Navigate to the docs directory:
+
+```bash
+cd docs
+```
+
+Build the HTML documentation:
+
+On macOS/Linux:
+
+```bash
+make html
+```
+
+On Windows:
+
+```powershell
+.\make.bat html
+```
+
+Finally, navigate to `_build/html/` and open `index.html` in a browser of your choice to view the documentation.
+
+---
 
 ## Standards and Guidelines
 
@@ -63,19 +132,22 @@ To maintain the quality and consistency of the codebase, we adhere to the follow
 4. **Coding Guidelines**: Adhere to the team's [coding guidelines document](https://github.com/SDNNetSim/sdn_simulator/blob/main/CONTRIBUTING.md).
 5. **Unit Testing**: Each unit test should follow the [community unit testing guidelines](https://pylonsproject.org/community-unit-testing-guidelines.html).
 
+---
+
 ## Contributors
 
-This project is brought to you by the efforts of Arash Rezaee, Ryan McCann, Kojo Bempah, and 
-Kimberly Tice. We welcome contributions from the community to help make this project even better!
+This project is brought to you by the efforts of **Arash Rezaee**, **Ryan McCann**, and **Vinod M. Vokkarane**. We welcome contributions from the community to help make this project even better!
+
+---
 
 ## 📖 How to Cite This Work
 
-If you use **FUSION** in your research, please cite the following paper:
+If you use FUSION in your research, please cite the following paper:
 
-> **R. McCann, A. Rezaee, and V. M. Vokkarane**,  
-> *"FUSION: A Flexible Unified Simulator for Intelligent Optical Networking,"*  
-> 2024 IEEE International Conference on Advanced Networks and Telecommunications Systems (ANTS), Guwahati, India, 2024, pp. 1-6.  
-> DOI: [10.1109/ANTS63515.2024.10898199](https://doi.org/10.1109/ANTS63515.2024.10898199)
+R. McCann, A. Rezaee, and V. M. Vokkarane,  
+"FUSION: A Flexible Unified Simulator for Intelligent Optical Networking,"  
+*2024 IEEE International Conference on Advanced Networks and Telecommunications Systems (ANTS)*, Guwahati, India, 2024, pp. 1-6.  
+DOI: [10.1109/ANTS63515.2024.10898199](https://doi.org/10.1109/ANTS63515.2024.10898199)
 
 ### 📄 BibTeX
 
@@ -88,3 +160,4 @@ If you use **FUSION** in your research, please cite the following paper:
   pages={1-6},
   doi={10.1109/ANTS63515.2024.10898199}
 }
+```

arg_scripts/sdn_args.py

@@ -65,7 +65,6 @@ def reset_params(self):
         self.band_list = list()
         self.start_slot_list = list()
         self.end_slot_list = list()
-        self.was_routed = None
 
     def get_data(self, key: str):
         """