Small changes

README.md

@@ -20,11 +20,11 @@ sodym dependencies are managed with [pip](https://pypi.org/project/pip/).
 
 To install as a user: run `python -m pip install sodym@git+https://github.com/pik-piam/sodym.git`
 
-To install as a developer, assuming you already have python installed:
+To install as a developer:
 
 1. Clone the sodym repository using git.
-2. From the project main directory, run `pip install -e ".[test]"` to obtain all the necessary
-dependencies, including those for running the tests.
+2. From the project main directory, run `pip install -e ".[test,docs,examples]"` to obtain all the necessary
+dependencies, including those for running the tests, making the documentation, and running the examples.
 
 Note that it is advisable to do this within a virtual environment.
 

tests/test_dimensions.py

@@ -8,7 +8,7 @@ def test_validate_dimension_set():
     # example valid DimensionSet
     dimensions = [
         {'name': 'time', 'letter': 't', 'items': [1990, 2000, 2010]},
-        {'name': 'place', 'letter': 'p', 'items': ['World', ]}
+        {'name': 'place', 'letter': 'p', 'items': ['World']}
     ]
     DimensionSet(dim_list=dimensions)
 
@@ -24,7 +24,7 @@ def test_validate_dimension_set():
 def test_get_subset():
     subset_dimensions = [
         {'name': 'time', 'letter': 't', 'items': [1990, 2000, 2010]},
-        {'name': 'place', 'letter': 'p', 'items': ['World', ]},
+        {'name': 'place', 'letter': 'p', 'items': ['World']},
     ]
     material_dimension = {'name': 'material', 'letter': 'm', 'items': ['material_0', 'material_1']}
 

tests/test_helpers.py

@@ -10,7 +10,7 @@
 dimension_set = DimensionSet(
     dim_list = [
         {'name': 'time', 'letter': 't', 'items': [1990, 2000, 2010]},
-        {'name': 'place', 'letter': 'p', 'items': ['World', ]}
+        {'name': 'place', 'letter': 'p', 'items': ['World']}
     ]
 )
 

tests/test_mfa_definition.py

@@ -22,7 +22,7 @@ def test_validate_mfa_definition():
             processes=[],
             flows=[],
             stocks=[
-                {'name': 'stock_zero', 'dim_letters': ('t', )},
+                {'name': 'stock_zero', 'dim_letters': ('t')},
             ],
             parameters=[],
         )

tests/test_named_dim_arrays.py

@@ -27,15 +27,15 @@ def test_named_dim_array_validations():
     dims = DimensionSet(dim_list=[local_places, time])
 
     # example with values with the correct shape
-    NamedDimArray(name='numbers', dims=dims, values=np.array([[1, 2, 3], ]))
+    NamedDimArray(name='numbers', dims=dims, values=np.array([[1, 2, 3]]))
 
     # example with dimensions reversed
     with pytest.raises(ValidationError):
-        NamedDimArray(name='numbers', dims=dims, values=np.array([[1], [2], [3], ]))
+        NamedDimArray(name='numbers', dims=dims, values=np.array([[1], [2], [3]]))
 
     # example with too many values
     with pytest.raises(ValidationError):
-        NamedDimArray(name='numbers', dims=dims, values=np.array([[1, 2, 3, 4], ]))
+        NamedDimArray(name='numbers', dims=dims, values=np.array([[1, 2, 3, 4]]))
 
     # example with no values passed -> filled with zeros
     zero_values = NamedDimArray(name='numbers', dims=dims)