In the class design document of this project (design/README.md), the class in the title is mentioned. Create it!

Procedure

[x] Create a file for the class implementation with name src/bacsim/[class_name].py, e.g. src/bacsim/simulation_parameters.py

Already done! Well done!

[x] Create a file for the class tests, with name tests/test-[class_name].py, e.g. tests/test-simulation_parameters.py
[x] Create a minimal class implementation, for example:

"""Simulation parameters."""

class SimulationParameters:

    """SimulationParameters holds the simulation's parameters."""

[x] Create a minimal class test, for example:

"""Tests all function in src.bacsim.simulation_parameters."""
import unittest

from src.bacsim.simulation_parameters import (
    SimulationParameters,
)

class TestSimulationParameters(unittest.TestCase):

    """Class to test the code in src.bacsim.simulation_parameters."""

    def test_can_create_params(self):
        """#14: Can construct a SimulationParameters."""
        SimulationParameters()

The test is that it works, not that it does anything useful.

Use the workflow that fits you best, ideally use a topic branch for this issue and merge to develop using a PR with code review.

programming-formalisms / programming_formalisms_project_summer_2024

Visualisation: Create Visualisation #37

Procedure