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

Trans #59

Merged
merged 7 commits into from
May 6, 2015
Merged

Trans #59

merged 7 commits into from
May 6, 2015

Conversation

opotowsky
Copy link
Member

Perhaps @gidden should check to make sure this is doing what he wants. This is basically listing all the simulation info / commodity and its mass. If correct, this will close issue #55

@gidden
Copy link
Member

gidden commented Apr 30, 2015

Thanks for getting to this so quickly, @opotowsky! Comments inline.

('Mass', ts.DOUBLE)
]

@metric(name='TransactionQuant', depends=_transdeps, schema=_transschema)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At a minimum, I would use Qty vs. Quant here to match similar usage across the project. I might further suggestion shortening to TransQty. Is there any official metric name style guidance?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is not! I welcome any and all input since it looks like this will be a part of the 1.3 release (you can skim metrics.py right now since the PR for online documentation is still waiting on input).

Thank you for the suggestion here, I will make the change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't use either. Just spell out Quantity.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I then update other shortened names? ElectricityGen comes to mind.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably. But that is a separate PR. Unless an abbreviation is approved by the style guide or in the docs, it should not be used. Currently we have no approved abbreviations.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood. Thanks!

@opotowsky
Copy link
Member Author

Alright @gidden, I think I addressed everything!

@gidden
Copy link
Member

gidden commented May 6, 2015

excuse my ignorance, but will the interface require an update when you generalize the Mass metric, or is that all implementation?

@opotowsky
Copy link
Member Author

I left Mass as is, except I added the units column to the metric, since generalizing it would require a rename (so I can just add a general metric another time). I just generalized TransactionQuantity here.

@gidden
Copy link
Member

gidden commented May 6, 2015

I guess what I'm saying is that the term Mass should be kept in the implementation and that the user-facing key should be Quantity. Including Units is definitely helpful and appreciated.

('ResourceId', ts.INT), ('ObjId', ts.INT),
('TimeCreated', ts.INT), ('SenderId', ts.INT),
('ReceiverId', ts.INT), ('Commodity', ts.STRING),
('Units', ts.STRING), ('Mass', ts.DOUBLE)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so here the schema key should be Quantity and not Mass

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OH! My oversight. Thanks. I'll change this to Quantity for the schema

@opotowsky
Copy link
Member Author

Finally, all ready @gidden

@gidden
Copy link
Member

gidden commented May 6, 2015

looks good, thanks @opotowsky

gidden added a commit that referenced this pull request May 6, 2015
@gidden gidden merged commit b6cbd9c into cyclus:master May 6, 2015
@opotowsky opotowsky deleted the trans branch May 6, 2015 19:47
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