Use src directory structure. (#8)

* Use src directory structure. Also remove MANIFEST.in, since all the data files seems to be picked up by setuptools by default. * Add test. * Fix inclusion of data files.
rte-france · Apr 12, 2024 · 306e363 · 306e363
1 parent 0614b2c
commit 306e363
Show file tree

Hide file tree

Showing 14 changed files with 21 additions and 6 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "stranded-cable"
 version = "2024.1.0"
 authors = [
-    {name = "Eurobios", email = "mgueguin@eurobios.com"},
+    {name = "Eurobios Mews Labs", email = "opentools@mews-labs.com"},
 ]
 description = "stranded-cable is a python package proposed to evaluate stranded cables' physical characteristics."
 readme = "README.md"
@@ -22,5 +22,8 @@ dependencies = [
     "matplotlib >= 3.7.1",
 ]
 
+[tool.setuptools.package-data]
+strdcable = ["data/*.csv", "*.ini"]
+
 [project.urls]
-"Homepage" = "https://gitlab.eurobios.com/rte/stranded-cable"
+"Repository" = "https://github.com/rte-france/pallas-standed-cable"
diff --git a/strdcable/__init__.py → src/strdcable/__init__.py b/strdcable/__init__.py → src/strdcable/__init__.py
diff --git a/strdcable/build_tools.py → src/strdcable/build_tools.py b/strdcable/build_tools.py → src/strdcable/build_tools.py
diff --git a/strdcable/cable.py → src/strdcable/cable.py b/strdcable/cable.py → src/strdcable/cable.py
diff --git a/strdcable/config.ini → src/strdcable/config.ini b/strdcable/config.ini → src/strdcable/config.ini
diff --git a/strdcable/config.py → src/strdcable/config.py b/strdcable/config.py → src/strdcable/config.py
diff --git a/...ata/FLEXION_CARDINAL_H40kN_mu0.7_FOTI.csv → ...ata/FLEXION_CARDINAL_H40kN_mu0.7_FOTI.csv b/...ata/FLEXION_CARDINAL_H40kN_mu0.7_FOTI.csv → ...ata/FLEXION_CARDINAL_H40kN_mu0.7_FOTI.csv
diff --git a/strdcable/data/cables_dataset.csv → src/strdcable/data/cables_dataset.csv b/strdcable/data/cables_dataset.csv → src/strdcable/data/cables_dataset.csv
diff --git a/strdcable/data/norm_OHL_EN_wires.csv → src/strdcable/data/norm_OHL_EN_wires.csv b/strdcable/data/norm_OHL_EN_wires.csv → src/strdcable/data/norm_OHL_EN_wires.csv
diff --git a/strdcable/geometrical_tools.py → src/strdcable/geometrical_tools.py b/strdcable/geometrical_tools.py → src/strdcable/geometrical_tools.py
diff --git a/strdcable/overheadlines.py → src/strdcable/overheadlines.py b/strdcable/overheadlines.py → src/strdcable/overheadlines.py
diff --git a/strdcable/physical_tools.py → src/strdcable/physical_tools.py b/strdcable/physical_tools.py → src/strdcable/physical_tools.py
diff --git a/tests/test_conductor.py b/tests/test_conductor.py
@@ -0,0 +1,16 @@
+import pytest
+import numpy as np
+
+def test_conductor():
+    from strdcable.cable import Conductor
+    cable = Conductor(
+            dwires=np.array([3e-3, 2e-3]),
+            nbwires=np.array([1, 6]),
+            material=np.array(['ST6C', 'AL1']),  # 'ST6C' is a grade of steel, 'AL1' is a grade of aluminium
+            laylengths=np.array([np.nan, 0.2])
+            )
+
+    assert cable.A == pytest.approx(2.5918139392115792e-05)
+    assert cable.m == pytest.approx(0.10604410834231327)
+    assert cable.EA == pytest.approx(2733197.4739603605)
+