Skip to content

Create paramaters-description.md#329

Open
derekwinton wants to merge 6 commits into
mrc-ide:masterfrom
derekwinton:patch-2
Open

Create paramaters-description.md#329
derekwinton wants to merge 6 commits into
mrc-ide:masterfrom
derekwinton:patch-2

Conversation

@derekwinton

Copy link
Copy Markdown
Contributor

This file explains the purpose of the paramaters class, groups variables by type to aid legibility and provides a description of each variable

This file explains the purpose of the paramaters class, groups variables by type to aid legibility and provides a description of each variable
@insidedctm

Copy link
Copy Markdown
Contributor

This seems like a good idea. You might want to keep an eye on some of the int parameters changing to bool- I can seem some changes in the param.h overnight.

Also parameter not paramater.

@derekwinton

Copy link
Copy Markdown
Contributor Author

Good catch on spelling, I have updated thanks.

I wasn't sure how to handle the bool / int distinction. They are integer values but treated as booleans ie 0= Off, 1=0n.

@insidedctm

Copy link
Copy Markdown
Contributor

I’m guessing there is a general desire to change variables to bool if that is how they are used. Makes sense.

Added variables related to cells and micro-cells
Reorganised quantitative information by category
Additional info on values
@weshinsley

weshinsley commented Jun 12, 2020

Copy link
Copy Markdown
Collaborator

A few pre-review thoughts on this
(1) Important to get started on this - thanks @derekwinton for kicking it off (some time ago...)
(2) I know a bunch of work has been going on documenting params, which will be on its way into a github form and may supercede this PR.
(3) I'd be excited about any creative way that the code could be self-documenting - possibly some pipeline that updates this .md and keeps it in sync, as I imagine it's easy to let these things slide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants