Skip to content

Commit 4e1317d

Browse files
Sbachmei/mic 6427/split manager and interface modules (#667)
1 parent 35e59d1 commit 4e1317d

File tree

31 files changed

+471
-346
lines changed

31 files changed

+471
-346
lines changed

CHANGELOG.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
**3.5.6 - 10/23/25**
2+
3+
- Split Interfaces and their respective Managers into different modules
4+
15
**3.5.5 - 10/14/25**
26

37
- Update simulation step log message to info level
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. automodule:: vivarium.framework.artifact.interface
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. automodule:: vivarium.framework.components.interface
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. automodule:: vivarium.framework.logging.interface
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. automodule:: vivarium.framework.lookup.interface
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. automodule:: vivarium.framework.randomness.interface
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. automodule:: vivarium.framework.resource.interface

docs/source/concepts/crn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Registering simulants
154154
++++++++++++++++++++++
155155

156156
Let's start with registering simulants. The randomness system provides the
157-
aptly named :func:`register_simulants <vivarium.framework.randomness.manager.RandomnessInterface.register_simulants>`,
157+
aptly named :func:`register_simulants <vivarium.framework.randomness.interface.RandomnessInterface.register_simulants>`,
158158
which handles the mapping process we looked at above where simulants'
159159
chosen characteristics are used to map them to a specific location in the
160160
**randomness index**. This should be used in initializing simulants.
@@ -178,7 +178,7 @@ RandomnessStreams
178178

179179
More commonly, you may want to get and use RandomnessStreams for specific
180180
**decision points**. The randomness system provides the
181-
:func:`get_stream <vivarium.framework.randomness.manager.RandomnessInterface.get_stream>` to do this. Let's
181+
:func:`get_stream <vivarium.framework.randomness.interface.RandomnessInterface.get_stream>` to do this. Let's
182182
look at a quick example of how we'd use this. Say we want a component that will
183183
move simulants one position left every time step with probability 0.5. We should
184184
use a :class:`RandomnessStreams <vivarium.framework.randomness.stream.RandomnessStream>`

docs/source/tutorials/disease_model.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Line 2 simply grabs a copy of the simulation
185185
a dictionary that supports ``.``-access notation.
186186

187187
Lines 4-18 interact with Vivarium's
188-
:class:`randomness system <vivarium.framework.randomness.manager.RandomnessInterface>`.
188+
:class:`randomness system <vivarium.framework.randomness.interface.RandomnessInterface>`.
189189
Several things are happening here.
190190

191191
Lines 4-13 deal with the topic of :doc:`Common Random Numbers </concepts/crn>`,

src/vivarium/framework/artifact/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from vivarium.framework.artifact.artifact import Artifact, ArtifactException
22
from vivarium.framework.artifact.hdf import EntityKey
3+
from vivarium.framework.artifact.interface import ArtifactInterface
34
from vivarium.framework.artifact.manager import (
4-
ArtifactInterface,
55
ArtifactManager,
66
filter_data,
77
parse_artifact_path_config,

0 commit comments

Comments
 (0)