Skip to content

Improve Getting Started documentation clarity and workflow #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harryswift01 merged 3 commits into from
Feb 5, 2026
Merged

Improve Getting Started documentation clarity and workflow #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25ed1ac
update `getting_started.rst` documentation for ease of use
harryswift01 Feb 4, 2026
93077c6
replace `thread` with `verbose` flag within `arg_config_manager.py`
harryswift01 Feb 4, 2026
043ea25
restore `--outfile` argument with JSON filename-only description
harryswift01 Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CodeEntropy/config/arg_config_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,12 @@
"action": "store_true",
"help": "Enable verbose output",
},
"thread": {"type": int, "help": "How many multiprocess to use", "default": 1},
"output_file": {
"type": str,
"help": "Name of the file where the output will be written",
"help": (
"Name of the output file to write results to (filename only). Defaults "
"to output_file.json"
),
"default": "output_file.json",
},
"force_partitioning": {"type": float, "help": "Force partitioning", "default": 0.5},
Expand Down
1 change: 1 addition & 0 deletions docs/developer_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ Edit docs in the following directories:

Contributing Code
-----------------
If you would to contribution to **CodeEntropy** please refer to our `Contributing Guidelines <https://github.com/CCPBioSim/CodeEntropy?tab=contributing-ov-file>`_

Creating an Issue
^^^^^^^^^^^^^^^^^
Expand Down
Loading