Feedback Documentation
General
-
Installation instructions is not one of the tabs at the top while many people might look for that first -
Might have to look into reducing the dependencies (torch and nvidia). Package is currently 7.6G on my computer.
Home
-
I have no clue what architecture section means but that might be my lack of knowledge.
User guide
-
Move optional dependencies to Dev Guide -
Same for dev install -
Update the configuration example - Currently it is not fully "just run the file" because the paths still have to be adjusted (at least the coloured case)
-
Explain what the example files are simulating -
Link to the relevant sections with explanations on the config etc. -
Explain what people are running with the examples - First a noise only run
- Then add signals
- Correlated noise requires a different simulator because codes are not designed for it
-
Add info about where people can find the different generators and what they do
API Reference
-
gwsim.cli Overview is empty -
gwsim.config: 404 Not Found -
Detail: functions and attributes are in a smaller font than the explanation which makes it very hard to follow the logical structure.
Developer Guide
-
Would it not be better to be consistent in advice to use uv instead of pip?