From 90dca9849132a34b928cb24db7d00a25aa051b9a Mon Sep 17 00:00:00 2001 From: Octavio Nascimento Date: Fri, 7 Nov 2025 22:53:10 -0300 Subject: [PATCH] Fix: Update requirements and README for Python 3.12 compatibility --- INSTALLATION_README.md | 48 ++++++++++++++++++++++++++++++++++++++++++ requirements.txt | 18 +++++++++------- 2 files changed, 58 insertions(+), 8 deletions(-) create mode 100644 INSTALLATION_README.md diff --git a/INSTALLATION_README.md b/INSTALLATION_README.md new file mode 100644 index 0000000..dc76a77 --- /dev/null +++ b/INSTALLATION_README.md @@ -0,0 +1,48 @@ +# CosmicBeats Simulator (Updated Installation Guide) + +This repository is a fork of Microsoft's [CosmicBeats-Simulator](https://github.com/microsoft/CosmicBeats-Simulator). This README provides updated and validated installation instructions to ensure compatibility with modern development environments (like macOS or PCs with new Python versions). + +The original simulation platform caters to diverse research interests, including networking, AI, computing, and more. + +## ⚠️ Critical Prerequisites: Python 3.12 + +The project's dependencies have **critical incompatibilities** with the latest Python versions (e.g., Python 3.13+). Attempting to install with a newer Python version will result in compilation errors (specifically for `pydantic-core`, a sub-dependency). + +To ensure a successful installation, you **must use Python 3.12**. + +### Required Tools (macOS Example) +1. **Homebrew** (for macOS): Used to install Python. [Install Homebrew here](https://brew.sh/). +2. **Git:** + ```bash + brew install git + ``` +3. **Python 3.12:** + ```bash + brew install python@3.12 + ``` +--- + +## 🚀 Installation Guide + +Please follow these steps exactly to set up your environment. + +### 1. Clone the Repository +Clone this repository to your local machine: +```bash +git clone [https://github.com/wocn-unicamp/CosmicBeats-Simulator.git](https://github.com/wocn-unicamp/CosmicBeats-Simulator.git) +cd CosmicBeats-Simulator + +### 2. Fix the requirements.txt File +The original requirements.txt file pins old package versions that conflict with modern Python. We must first overwrite it to allow pip to install the latest compatible versions. +Replace the entire content of your requirements.txt file with the following: + +astropy +dask +geopy +gradio +numpy +pandas +plotly +scipy +statsmodels +tqdm \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 8c2c6b4..dc14651 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,10 @@ -astropy==5.3.1 -dask==2023.7.1 -geopy==2.3.0 -gradio==3.39.0 -numpy==1.25.1 -pandas==2.0.3 -plotly==5.15.0 -skyfield==1.46 +astropy +dask +geopy +gradio +numpy +pandas +plotly +scipy +statsmodels +tqdm \ No newline at end of file