Add cross-platform development setup documentation#13
Open
parthdagia05 wants to merge 1 commit intoOSeMOSYS:masterfrom
Open
Add cross-platform development setup documentation#13parthdagia05 wants to merge 1 commit intoOSeMOSYS:masterfrom
parthdagia05 wants to merge 1 commit intoOSeMOSYS:masterfrom
Conversation
- Add macOS/Linux/Windows from-source setup guide - Document solver installation and PATH configuration - Document requirements.txt encoding behavior - Document DataStorage permission considerations - Register page in Getting Started toctree - Link documentation from README Refs OSeMOSYS#12
Author
|
@VedranKapor can you review this. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation: Cross-Platform Development & Source Setup Guide
Closes #12
Overview
Currently, the project documentation primarily covers the Windows
.exeinstallation workflow. This PR introduces comprehensive guides for setting up and running MUIO from source on macOS, Linux, and Windows, reducing onboarding friction for new contributors and research teams.What’s New?
1. Dedicated Development Setup Page
Created
docs/source/getting-started/dev-setup.rstwhich provides step-by-step instructions for:.exe.MUIO_GLPK_PATHandMUIO_CBC_PATHenvironment variables.2. Technical Deep-Dives
Added documentation for previously "hidden" logic discovered in the codebase:
$PATH.UTF-16LEencoding inrequirements.txt.DATA_STORAGEdirectory permissions (0o777) required for successful execution.3. Improved Discoverability
docs/source/index.rstto include the new guide in the main Table of Contents.README.mdto point users directly to the full documentation.Impact & Risk
.rstand.mdfiles. No functional code is modified.Checklist