Agents Metric

[scopatz]

This implements an "Agents" table and metric that matches the schema and semantics of a table by the same name that is generated by cyclist. It also addresses a deficiency in the cyclist table where the ExitTime could be greater than the duration. Some fixes, ui improvements, and interfaces have been updated along the way.

[rwcarlsen]

If the exit time is not specified in the original db and the agent was never scheduled for decommissioning, what is put in the ExitTime column here? - I'm not familiar enough with pandas to know by just looking at the code. The value should be maintained as "NULL", -1, or some other such non-normal value because no exit time is semantically different to cyclus than a future or end of sim exit time - particularly w.r.t. restart/branching.

[opotowsky]

I'm getting errors when I run nosetests that relate to the tests not being able to import cyclus

[scopatz]

I'm getting errors when I run nosetests that relate to the tests not being able to import cyclus

What directory are you in?

[opotowsky]

cymetric/tests when I run nosetests

[scopatz]

hmmm can you post the error please?

[scopatz]

Did you re-install?

[opotowsky]

I did reinstall cymetric (oh so cleanly)

Here are the errors I get:

opotowsky_eats_CakeBalls ~/cyclus/cymetric/tests (master) $ nosetests
EEEE
======================================================================
ERROR: Failure: AttributeError (attribute '__doc__' of 'type' objects is not writable)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/nose/loader.py", line 414, in loadTestsFromName
    addr.filename, addr.module)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 47, in importFromPath
    return self.importFromDir(dir_path, fqname)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 94, in importFromDir
    mod = load_module(part_fqname, fh, filename, desc)
  File "/home/opotowsky/cyclus/cymetric/tests/test_cyclus.py", line 9, in <module>
    from cymetric import cyclus
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/__init__.py", line 10, in <module>
    from cymetric.metrics import Metric, metric
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/metrics.py", line 77, in <module>
    @metric(name='Materials', depends=_matdeps, schema=_matschema)
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/metrics.py", line 58, in dec
    return _genmetricclass(f=f, name=clsname, scheme=schema, depends=depends)
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/metrics.py", line 50, in _genmetricclass
    Cls.__doc__ = inspect.getdoc(f)
AttributeError: attribute '__doc__' of 'type' objects is not writable

======================================================================
ERROR: Failure: ImportError (cannot import name cyclus)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/nose/loader.py", line 414, in loadTestsFromName
    addr.filename, addr.module)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 47, in importFromPath
    return self.importFromDir(dir_path, fqname)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 94, in importFromDir
    mod = load_module(part_fqname, fh, filename, desc)
  File "/home/opotowsky/cyclus/cymetric/tests/test_evaluator.py", line 7, in <module>
    from cymetric import evaluator
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/__init__.py", line 10, in <module>
    from cymetric.metrics import Metric, metric
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/metrics.py", line 9, in <module>
    from cymetric import cyclus
ImportError: cannot import name cyclus

======================================================================
ERROR: Failure: ImportError (cannot import name cyclus)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/nose/loader.py", line 414, in loadTestsFromName
    addr.filename, addr.module)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 47, in importFromPath
    return self.importFromDir(dir_path, fqname)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 94, in importFromDir
    mod = load_module(part_fqname, fh, filename, desc)
  File "/home/opotowsky/cyclus/cymetric/tests/test_metrics.py", line 15, in <module>
    from cymetric import cyclus
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/__init__.py", line 10, in <module>
    from cymetric.metrics import Metric, metric
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/metrics.py", line 9, in <module>
    from cymetric import cyclus
ImportError: cannot import name cyclus

======================================================================
ERROR: Failure: ImportError (cannot import name cyclus)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/nose/loader.py", line 414, in loadTestsFromName
    addr.filename, addr.module)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 47, in importFromPath
    return self.importFromDir(dir_path, fqname)
  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 94, in importFromDir
    mod = load_module(part_fqname, fh, filename, desc)
  File "/home/opotowsky/cyclus/cymetric/tests/test_root_metrics.py", line 10, in <module>
    from cymetric import cyclus
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/__init__.py", line 10, in <module>
    from cymetric.metrics import Metric, metric
  File "/home/opotowsky/.local/lib/python2.7/site-packages/cymetric/metrics.py", line 9, in <module>
    from cymetric import cyclus
ImportError: cannot import name cyclus

----------------------------------------------------------------------
Ran 4 tests in 0.321s

FAILED (errors=4)

[scopatz]

@rwcarlsen

If the exit time is not specified in the original db and the agent was never scheduled for decommissioning, what is put in the ExitTime column here?

It puts in the simulation duration from the Info table. I think that this is better than what cyclist does, which is to add the simulation duration to the EnterTime. For example, if the simulation duration is 100, and the enter time for an agent is 10, then cymetric will use 100 as the exit time and cyclist will use 110.

The value should be maintained as "NULL", -1, or some other such non-normal value because no exit time is semantically different to cyclus than a future or end of sim exit time - particularly w.r.t. restart/branching.

It is maintained in the appropriate tables (AgentEnter, AgentExit, DecomSched, etc). The Agents table, like in cyclist is present for analysis and visualization, not for restart. It is there to be able to figure out in a consistent manner when agents are alive. Calling the last column AgentExit is probably a misnomer, but I was trying to match the cyclist table. It is hard to create a plot when the upper value of the time range is NaN :). I hope that this explains it.

[scopatz]

@opotowsky this seems to be a Python 2 issue, or at least the first one is.

[opotowsky]

I clean installed both cyclus and cymetric and am still getting the import errors. Should I worry about the first error?

[scopatz]

I'll try to get a fix in for these later today.

[opotowsky]

thanks so much!

[scopatz]

@opotowsky can you try the docstring fix I have just pushed up?

[opotowsky]

Thanks for the quick fix, but now I get this!

opotowsky_eats_CakeBalls ~/cyclus/cymetric/tests (master) $ nosetests
..........E..
======================================================================
ERROR: test_metrics.test_agents
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/nose/case.py", line 197, in runTest
    self.test(*self.arg)
  File "/home/opotowsky/cyclus/cymetric/tests/test_metrics.py", line 40, in test_agents
    ('EnterTime', '<i8'), ('ExitTime', '<f8')])
TypeError: data type not understood

----------------------------------------------------------------------
Ran 13 tests in 0.721s

FAILED (errors=1)

[scopatz]

Ok! Try this.

[scopatz]

Alright, I have now updated this to actually work on Python 2. Sorry it took me a while. I had to install Python 2, etc :)

[opotowsky]

On my bat-loving, hdf5-hating computer now so those are the only test failures. Excitedly merging, thanks @scopatz!