{"action":"created","comment":{"url":"https://api.github.com/repos/mit-crpg/openmc/pulls/comments/32947859","id":32947859,"diff_hunk":"@@ -21,9 +22,58 @@ def reset_auto_tally_id():\n \n \n class Tally(object):\n+    \"\"\"A tally defined by a set of scores that are accumulated for a list of\n+    nuclides given a set of filters.\n+\n+    Parameters\n+    ----------\n+    tally_id : int\n+        Unique identifier for the tally\n+    name : str\n+        Name of the taly\n+\n+    Attributes\n+    ----------\n+    id : int\n+        Unique identifier for the tally\n+    name : str\n+        Name of the tally\n+    filters : list of openmc.filter.Filter\n+        List of specified filters for the tally\n+    nuclides : list of openmc.nuclide.Nuclide\n+        List of nuclides to score results for\n+    scores : list of str\n+        List of defined scores, e.g. 'flux', 'fission', etc.\n+    estimator : {'analog', 'tracklength'}\n+        Type of estimator for the tally\n+    triggers : list of openmc.trigger.Trigger\n+        List of tally triggers\n+    num_score_bins : int\n+        Total number of scores, accounting for the fact that a single\n+        user-specified score might have multiple bins","path":"openmc/tallies.py","position":39,"original_position":39,"commit_id":"355715f5341d471377488cd9c4a804ad36df8cc3","original_commit_id":"355715f5341d471377488cd9c4a804ad36df8cc3","user":{"login":"wbinventor","id":209492,"avatar_url":"https://avatars.githubusercontent.com/u/209492?v=3","gravatar_id":"","url":"https://api.github.com/users/wbinventor","html_url":"https://github.com/wbinventor","followers_url":"https://api.github.com/users/wbinventor/followers","following_url":"https://api.github.com/users/wbinventor/following{/other_user}","gists_url":"https://api.github.com/users/wbinventor/gists{/gist_id}","starred_url":"https://api.github.com/users/wbinventor/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wbinventor/subscriptions","organizations_url":"https://api.github.com/users/wbinventor/orgs","repos_url":"https://api.github.com/users/wbinventor/repos","events_url":"https://api.github.com/users/wbinventor/events{/privacy}","received_events_url":"https://api.github.com/users/wbinventor/received_events","type":"User","site_admin":false},"body":"I might just add something like \"(e.g., 'scatter-P3', 'flux-Y2,2')\" in case some users find this concept confusing (I did when I began using the code)","created_at":"2015-06-22T15:36:36Z","updated_at":"2015-06-22T15:36:36Z","html_url":"https://github.com/mit-crpg/openmc/pull/400#discussion_r32947859","pull_request_url":"https://api.github.com/repos/mit-crpg/openmc/pulls/400","_links":{"self":{"href":"https://api.github.com/repos/mit-crpg/openmc/pulls/comments/32947859"},"html":{"href":"https://github.com/mit-crpg/openmc/pull/400#discussion_r32947859"},"pull_request":{"href":"https://api.github.com/repos/mit-crpg/openmc/pulls/400"}}},"pull_request":{"url":"https://api.github.com/repos/mit-crpg/openmc/pulls/400","id":37657265,"html_url":"https://github.com/mit-crpg/openmc/pull/400","diff_url":"https://github.com/mit-crpg/openmc/pull/400.diff","patch_url":"https://github.com/mit-crpg/openmc/pull/400.patch","issue_url":"https://api.github.com/repos/mit-crpg/openmc/issues/400","number":400,"state":"open","locked":false,"title":"Initial documentation for Python API","user":{"login":"paulromano","id":743095,"avatar_url":"https://avatars.githubusercontent.com/u/743095?v=3","gravatar_id":"","url":"https://api.github.com/users/paulromano","html_url":"https://github.com/paulromano","followers_url":"https://api.github.com/users/paulromano/followers","following_url":"https://api.github.com/users/paulromano/following{/other_user}","gists_url":"https://api.github.com/users/paulromano/gists{/gist_id}","starred_url":"https://api.github.com/users/paulromano/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paulromano/subscriptions","organizations_url":"https://api.github.com/users/paulromano/orgs","repos_url":"https://api.github.com/users/paulromano/repos","events_url":"https://api.github.com/users/paulromano/events{/privacy}","received_events_url":"https://api.github.com/users/paulromano/received_events","type":"User","site_admin":false},"body":"This pull request adds very crude documentation for the Python API. Essentially, all classes/methods have docstrings which are used to autogenerate documentation. The API documentation is not super user-friendly yet, but at least it's there. I plan on submitting another PR or two to improve the API and documentation further.\r\n\r\nTo highlight the changes:\r\n- docstrings added to (almost) all methods\r\n- When creating XML elements that have a list of numbers, use the idiomatic expression `' '.join(map(str, ...))`.\r\n- Made `create_*_subelement` methods private\r\n- Various fixes for PEP8 conformance\r\n- Fixed properties for CMFD classes","created_at":"2015-06-15T04:13:27Z","updated_at":"2015-06-22T15:36:36Z","closed_at":null,"merged_at":null,"merge_commit_sha":"cc035dc035b6c04197f85ccf76ec8e97c6451120","assignee":{"login":"wbinventor","id":209492,"avatar_url":"https://avatars.githubusercontent.com/u/209492?v=3","gravatar_id":"","url":"https://api.github.com/users/wbinventor","html_url":"https://github.com/wbinventor","followers_url":"https://api.github.com/users/wbinventor/followers","following_url":"https://api.github.com/users/wbinventor/following{/other_user}","gists_url":"https://api.github.com/users/wbinventor/gists{/gist_id}","starred_url":"https://api.github.com/users/wbinventor/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wbinventor/subscriptions","organizations_url":"https://api.github.com/users/wbinventor/orgs","repos_url":"https://api.github.com/users/wbinventor/repos","events_url":"https://api.github.com/users/wbinventor/events{/privacy}","received_events_url":"https://api.github.com/users/wbinventor/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/mit-crpg/openmc/milestones/11","html_url":"https://github.com/mit-crpg/openmc/milestones/v0.7","labels_url":"https://api.github.com/repos/mit-crpg/openmc/milestones/11/labels","id":769762,"number":11,"title":"v0.7","description":"","creator":{"login":"paulromano","id":743095,"avatar_url":"https://avatars.githubusercontent.com/u/743095?v=3","gravatar_id":"","url":"https://api.github.com/users/paulromano","html_url":"https://github.com/paulromano","followers_url":"https://api.github.com/users/paulromano/followers","following_url":"https://api.github.com/users/paulromano/following{/other_user}","gists_url":"https://api.github.com/users/paulromano/gists{/gist_id}","starred_url":"https://api.github.com/users/paulromano/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paulromano/subscriptions","organizations_url":"https://api.github.com/users/paulromano/orgs","repos_url":"https://api.github.com/users/paulromano/repos","events_url":"https://api.github.com/users/paulromano/events{/privacy}","received_events_url":"https://api.github.com/users/paulromano/received_events","type":"User","site_admin":false},"open_issues":4,"closed_issues":21,"state":"open","created_at":"2014-08-28T15:56:37Z","updated_at":"2015-06-15T04:13:27Z","due_on":"2015-03-31T04:00:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/mit-crpg/openmc/pulls/400/commits","review_comments_url":"https://api.github.com/repos/mit-crpg/openmc/pulls/400/comments","review_comment_url":"https://api.github.com/repos/mit-crpg/openmc/pulls/comments{/number}","comments_url":"https://api.github.com/repos/mit-crpg/openmc/issues/400/comments","statuses_url":"https://api.github.com/repos/mit-crpg/openmc/statuses/355715f5341d471377488cd9c4a804ad36df8cc3","head":{"label":"paulromano:python-api-doc","ref":"python-api-doc","sha":"355715f5341d471377488cd9c4a804ad36df8cc3","user":{"login":"paulromano","id":743095,"avatar_url":"https://avatars.githubusercontent.com/u/743095?v=3","gravatar_id":"","url":"https://api.github.com/users/paulromano","html_url":"https://github.com/paulromano","followers_url":"https://api.github.com/users/paulromano/followers","following_url":"https://api.github.com/users/paulromano/following{/other_user}","gists_url":"https://api.github.com/users/paulromano/gists{/gist_id}","starred_url":"https://api.github.com/users/paulromano/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paulromano/subscriptions","organizations_url":"https://api.github.com/users/paulromano/orgs","repos_url":"https://api.github.com/users/paulromano/repos","events_url":"https://api.github.com/users/paulromano/events{/privacy}","received_events_url":"https://api.github.com/users/paulromano/received_events","type":"User","site_admin":false},"repo":{"id":6039026,"name":"openmc","full_name":"paulromano/openmc","owner":{"login":"paulromano","id":743095,"avatar_url":"https://avatars.githubusercontent.com/u/743095?v=3","gravatar_id":"","url":"https://api.github.com/users/paulromano","html_url":"https://github.com/paulromano","followers_url":"https://api.github.com/users/paulromano/followers","following_url":"https://api.github.com/users/paulromano/following{/other_user}","gists_url":"https://api.github.com/users/paulromano/gists{/gist_id}","starred_url":"https://api.github.com/users/paulromano/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paulromano/subscriptions","organizations_url":"https://api.github.com/users/paulromano/orgs","repos_url":"https://api.github.com/users/paulromano/repos","events_url":"https://api.github.com/users/paulromano/events{/privacy}","received_events_url":"https://api.github.com/users/paulromano/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/paulromano/openmc","description":"OpenMC Monte Carlo Code","fork":true,"url":"https://api.github.com/repos/paulromano/openmc","forks_url":"https://api.github.com/repos/paulromano/openmc/forks","keys_url":"https://api.github.com/repos/paulromano/openmc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/paulromano/openmc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/paulromano/openmc/teams","hooks_url":"https://api.github.com/repos/paulromano/openmc/hooks","issue_events_url":"https://api.github.com/repos/paulromano/openmc/issues/events{/number}","events_url":"https://api.github.com/repos/paulromano/openmc/events","assignees_url":"https://api.github.com/repos/paulromano/openmc/assignees{/user}","branches_url":"https://api.github.com/repos/paulromano/openmc/branches{/branch}","tags_url":"https://api.github.com/repos/paulromano/openmc/tags","blobs_url":"https://api.github.com/repos/paulromano/openmc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/paulromano/openmc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/paulromano/openmc/git/refs{/sha}","trees_url":"https://api.github.com/repos/paulromano/openmc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/paulromano/openmc/statuses/{sha}","languages_url":"https://api.github.com/repos/paulromano/openmc/languages","stargazers_url":"https://api.github.com/repos/paulromano/openmc/stargazers","contributors_url":"https://api.github.com/repos/paulromano/openmc/contributors","subscribers_url":"https://api.github.com/repos/paulromano/openmc/subscribers","subscription_url":"https://api.github.com/repos/paulromano/openmc/subscription","commits_url":"https://api.github.com/repos/paulromano/openmc/commits{/sha}","git_commits_url":"https://api.github.com/repos/paulromano/openmc/git/commits{/sha}","comments_url":"https://api.github.com/repos/paulromano/openmc/comments{/number}","issue_comment_url":"https://api.github.com/repos/paulromano/openmc/issues/comments{/number}","contents_url":"https://api.github.com/repos/paulromano/openmc/contents/{+path}","compare_url":"https://api.github.com/repos/paulromano/openmc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/paulromano/openmc/merges","archive_url":"https://api.github.com/repos/paulromano/openmc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/paulromano/openmc/downloads","issues_url":"https://api.github.com/repos/paulromano/openmc/issues{/number}","pulls_url":"https://api.github.com/repos/paulromano/openmc/pulls{/number}","milestones_url":"https://api.github.com/repos/paulromano/openmc/milestones{/number}","notifications_url":"https://api.github.com/repos/paulromano/openmc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/paulromano/openmc/labels{/name}","releases_url":"https://api.github.com/repos/paulromano/openmc/releases{/id}","created_at":"2012-10-02T01:55:56Z","updated_at":"2015-04-25T14:43:09Z","pushed_at":"2015-06-16T10:17:13Z","git_url":"git://github.com/paulromano/openmc.git","ssh_url":"git@github.com:paulromano/openmc.git","clone_url":"https://github.com/paulromano/openmc.git","svn_url":"https://github.com/paulromano/openmc","homepage":"","size":18405,"stargazers_count":2,"watchers_count":2,"language":"FORTRAN","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":0,"forks":1,"open_issues":0,"watchers":2,"default_branch":"master"}},"base":{"label":"mit-crpg:develop","ref":"develop","sha":"b5f71255a3d4f8aef14809ad99ce6a9182a93409","user":{"login":"mit-crpg","id":1247634,"avatar_url":"https://avatars.githubusercontent.com/u/1247634?v=3","gravatar_id":"","url":"https://api.github.com/users/mit-crpg","html_url":"https://github.com/mit-crpg","followers_url":"https://api.github.com/users/mit-crpg/followers","following_url":"https://api.github.com/users/mit-crpg/following{/other_user}","gists_url":"https://api.github.com/users/mit-crpg/gists{/gist_id}","starred_url":"https://api.github.com/users/mit-crpg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mit-crpg/subscriptions","organizations_url":"https://api.github.com/users/mit-crpg/orgs","repos_url":"https://api.github.com/users/mit-crpg/repos","events_url":"https://api.github.com/users/mit-crpg/events{/privacy}","received_events_url":"https://api.github.com/users/mit-crpg/received_events","type":"Organization","site_admin":false},"repo":{"id":2081118,"name":"openmc","full_name":"mit-crpg/openmc","owner":{"login":"mit-crpg","id":1247634,"avatar_url":"https://avatars.githubusercontent.com/u/1247634?v=3","gravatar_id":"","url":"https://api.github.com/users/mit-crpg","html_url":"https://github.com/mit-crpg","followers_url":"https://api.github.com/users/mit-crpg/followers","following_url":"https://api.github.com/users/mit-crpg/following{/other_user}","gists_url":"https://api.github.com/users/mit-crpg/gists{/gist_id}","starred_url":"https://api.github.com/users/mit-crpg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mit-crpg/subscriptions","organizations_url":"https://api.github.com/users/mit-crpg/orgs","repos_url":"https://api.github.com/users/mit-crpg/repos","events_url":"https://api.github.com/users/mit-crpg/events{/privacy}","received_events_url":"https://api.github.com/users/mit-crpg/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mit-crpg/openmc","description":"OpenMC Monte Carlo Code","fork":false,"url":"https://api.github.com/repos/mit-crpg/openmc","forks_url":"https://api.github.com/repos/mit-crpg/openmc/forks","keys_url":"https://api.github.com/repos/mit-crpg/openmc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mit-crpg/openmc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mit-crpg/openmc/teams","hooks_url":"https://api.github.com/repos/mit-crpg/openmc/hooks","issue_events_url":"https://api.github.com/repos/mit-crpg/openmc/issues/events{/number}","events_url":"https://api.github.com/repos/mit-crpg/openmc/events","assignees_url":"https://api.github.com/repos/mit-crpg/openmc/assignees{/user}","branches_url":"https://api.github.com/repos/mit-crpg/openmc/branches{/branch}","tags_url":"https://api.github.com/repos/mit-crpg/openmc/tags","blobs_url":"https://api.github.com/repos/mit-crpg/openmc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mit-crpg/openmc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mit-crpg/openmc/git/refs{/sha}","trees_url":"https://api.github.com/repos/mit-crpg/openmc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mit-crpg/openmc/statuses/{sha}","languages_url":"https://api.github.com/repos/mit-crpg/openmc/languages","stargazers_url":"https://api.github.com/repos/mit-crpg/openmc/stargazers","contributors_url":"https://api.github.com/repos/mit-crpg/openmc/contributors","subscribers_url":"https://api.github.com/repos/mit-crpg/openmc/subscribers","subscription_url":"https://api.github.com/repos/mit-crpg/openmc/subscription","commits_url":"https://api.github.com/repos/mit-crpg/openmc/commits{/sha}","git_commits_url":"https://api.github.com/repos/mit-crpg/openmc/git/commits{/sha}","comments_url":"https://api.github.com/repos/mit-crpg/openmc/comments{/number}","issue_comment_url":"https://api.github.com/repos/mit-crpg/openmc/issues/comments{/number}","contents_url":"https://api.github.com/repos/mit-crpg/openmc/contents/{+path}","compare_url":"https://api.github.com/repos/mit-crpg/openmc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mit-crpg/openmc/merges","archive_url":"https://api.github.com/repos/mit-crpg/openmc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mit-crpg/openmc/downloads","issues_url":"https://api.github.com/repos/mit-crpg/openmc/issues{/number}","pulls_url":"https://api.github.com/repos/mit-crpg/openmc/pulls{/number}","milestones_url":"https://api.github.com/repos/mit-crpg/openmc/milestones{/number}","notifications_url":"https://api.github.com/repos/mit-crpg/openmc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mit-crpg/openmc/labels{/name}","releases_url":"https://api.github.com/repos/mit-crpg/openmc/releases{/id}","created_at":"2011-07-21T00:33:27Z","updated_at":"2015-06-17T17:09:45Z","pushed_at":"2015-06-16T10:17:15Z","git_url":"git://github.com/mit-crpg/openmc.git","ssh_url":"git@github.com:mit-crpg/openmc.git","clone_url":"https://github.com/mit-crpg/openmc.git","svn_url":"https://github.com/mit-crpg/openmc","homepage":"http://mit-crpg.github.io/openmc/","size":34775,"stargazers_count":55,"watchers_count":55,"language":"FORTRAN","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":74,"mirror_url":null,"open_issues_count":34,"forks":74,"open_issues":34,"watchers":55,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/mit-crpg/openmc/pulls/400"},"html":{"href":"https://github.com/mit-crpg/openmc/pull/400"},"issue":{"href":"https://api.github.com/repos/mit-crpg/openmc/issues/400"},"comments":{"href":"https://api.github.com/repos/mit-crpg/openmc/issues/400/comments"},"review_comments":{"href":"https://api.github.com/repos/mit-crpg/openmc/pulls/400/comments"},"review_comment":{"href":"https://api.github.com/repos/mit-crpg/openmc/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/mit-crpg/openmc/pulls/400/commits"},"statuses":{"href":"https://api.github.com/repos/mit-crpg/openmc/statuses/355715f5341d471377488cd9c4a804ad36df8cc3"}}}}