Skip to content
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.

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

Packaging Todo List #16

Open
9 of 12 tasks
dmcglinn opened this issue Nov 21, 2013 · 2 comments
Open
9 of 12 tasks

Packaging Todo List #16

dmcglinn opened this issue Nov 21, 2013 · 2 comments

Comments

@dmcglinn
Copy link
Collaborator

Code Cleaning

  • should we keep the long doc string at the top of partitions.py that introduces the purpose and contents of the script? Is this better placed elsewhere?
  • add more annotation to the algorithm portion of the code
  • clean up superfluous stray annotations
  • make sure that function arguments are defined in clear and concrete ways. Link terms in the functions back to terms used in the manuscript. For example part in the manuscript was referred to as an element of a partition. This should be made clear in the annotation.
  • ensure that part refers to an element of a partition and parts refers to multiple elements of a partition
    • this is going to require changing object names in the code
  • NrParts function
    • add more explanation of function's purpose
    • add citation to sage code
    • decide if there a namespace issue with this function because a function of the same with almost the exact same code exists in Sage
  • drop hash bang in partitions.py
  • import division from future
  • rand_parts function
    • method best requires a file that has which algo is best for a given Q-N combo
    • decide what algo to use when Q-N combo is outside our knowledge
  • omit function numparts_QNK

Code Testing

  • add test on function NrParts
    • test should check that NrParts returns the correct integer for various combos of Q and N
  • add test to check for bias in algos
    • this will compare the moments of the random samples of the feasible set to the moments of a completely enumerated feasible set
@ghost ghost assigned dmcglinn and klocey Nov 21, 2013
@dmcglinn
Copy link
Collaborator Author

Another todo: convert the python test script so that it uses the package nose

@klocey
Copy link
Owner

klocey commented Jan 31, 2021

Beautiful list of to-do's. I'll work on them. I also updated the print statements in pypartitions for python 3, replaced xrange with range, and finished addressing issues raised by others.

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

No branches or pull requests

2 participants