Docs: clarify installation workflow and independent project structure #115
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.
Summary
This PR improves the root-level documentation and installation workflow
for the DeepLense repository.
DeepLense is a research monorepo containing multiple independent projects.
Previously, the lack of clear installation instructions caused confusion
around dependency setup and execution (e.g. attempts to use
pip install .or assuming a single global
train.py).This PR clarifies the correct usage pattern and improves reproducibility,
especially for fresh Windows environments.
What this PR changes
requirements.txtcontaining common dependenciesshared across multiple DeepLense projects
README.mdto clearly explain:pip install .How to install and run
Create and activate a virtual environment:
Install common dependencies:
pip install -r requirements.txt
Navigate to a project directory:
cd <project_directory>
Identify the entry point (script or notebook) and run it:
python <script_name>.py
or
jupyter notebook
There is no single global execution command for the entire repository.
Tested on Windows 10 with Python 3.11 in a fresh virtual environment
Verified that core dependencies import successfully
Confirmed that project scripts run without dependency-related errors
when executed from the correct subdirectory