Basic python packaging (#20)

* moved all code under a package dir * install instructions
prommis · Nov 13, 2023 · 60e6755 · 60e6755
1 parent 71f50b8
commit 60e6755
Show file tree

Hide file tree

Showing 29 changed files with 128 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,10 @@
 # workspace
 Internal repo for sharing code
+
+## Installation
+To install dependencies (developer mode),
+from the top directory of the repo, run:
+```
+pip install -r .\requirements-dev.txt
+```
+
diff --git a/Solvent_Extraction/REEAqdistribution.py → ...e/Solvent_Extraction/REEAqdistribution.py b/Solvent_Extraction/REEAqdistribution.py → ...e/Solvent_Extraction/REEAqdistribution.py
diff --git a/Solvent_Extraction/REEOgdistribution.py → ...e/Solvent_Extraction/REEOgdistribution.py b/Solvent_Extraction/REEOgdistribution.py → ...e/Solvent_Extraction/REEOgdistribution.py
diff --git a/Solvent_Extraction/REESXmodel.py → ...orkspace/Solvent_Extraction/REESXmodel.py b/Solvent_Extraction/REESXmodel.py → ...orkspace/Solvent_Extraction/REESXmodel.py
diff --git a/Solvent_Extraction/pytestSXmodel.py → ...space/Solvent_Extraction/pytestSXmodel.py b/Solvent_Extraction/pytestSXmodel.py → ...space/Solvent_Extraction/pytestSXmodel.py
diff --git a/Solvent_Extraction/testSXmodel.py → ...rkspace/Solvent_Extraction/testSXmodel.py b/Solvent_Extraction/testSXmodel.py → ...rkspace/Solvent_Extraction/testSXmodel.py
diff --git a/...Translators/translator_SX_precipitator.py → ...Translators/translator_SX_precipitator.py b/...Translators/translator_SX_precipitator.py → ...Translators/translator_SX_precipitator.py
diff --git a/...eet/Translators/translator_leaching_SX.py → ...eet/Translators/translator_leaching_SX.py b/...eet/Translators/translator_leaching_SX.py → ...eet/Translators/translator_leaching_SX.py
diff --git a/UKy_flowsheet/__init__.py → prommis_workspace/UKy_flowsheet/__init__.py b/UKy_flowsheet/__init__.py → prommis_workspace/UKy_flowsheet/__init__.py
diff --git a/...sheet/costing/REE_costing_parameters.json → ...sheet/costing/REE_costing_parameters.json b/...sheet/costing/REE_costing_parameters.json → ...sheet/costing/REE_costing_parameters.json
diff --git a/UKy_flowsheet/costing/__init__.py → ...rkspace/UKy_flowsheet/costing/__init__.py b/UKy_flowsheet/costing/__init__.py → ...rkspace/UKy_flowsheet/costing/__init__.py
diff --git a/...flowsheet/costing/costing_dictionaries.py → ...flowsheet/costing/costing_dictionaries.py b/...flowsheet/costing/costing_dictionaries.py → ...flowsheet/costing/costing_dictionaries.py
diff --git a/UKy_flowsheet/costing/ree_plant_capcost.py → ...Ky_flowsheet/costing/ree_plant_capcost.py b/UKy_flowsheet/costing/ree_plant_capcost.py → ...Ky_flowsheet/costing/ree_plant_capcost.py
diff --git a/UKy_flowsheet/costing/ree_test_flowsheet.py → ...y_flowsheet/costing/ree_test_flowsheet.py b/UKy_flowsheet/costing/ree_test_flowsheet.py → ...y_flowsheet/costing/ree_test_flowsheet.py
diff --git a/UKy_flowsheet/filter_press/__init__.py → ...ce/UKy_flowsheet/filter_press/__init__.py b/UKy_flowsheet/filter_press/__init__.py → ...ce/UKy_flowsheet/filter_press/__init__.py
diff --git a/...et/filter_press/filter_press_flowsheet.py → ...et/filter_press/filter_press_flowsheet.py b/...et/filter_press/filter_press_flowsheet.py → ...et/filter_press/filter_press_flowsheet.py
diff --git a/...r_press/filter_press_solids_properties.py → ...r_press/filter_press_solids_properties.py b/...r_press/filter_press_solids_properties.py → ...r_press/filter_press_solids_properties.py
diff --git a/...press/filter_press_solution_properties.py → ...press/filter_press_solution_properties.py b/...press/filter_press_solution_properties.py → ...press/filter_press_solution_properties.py
diff --git a/UKy_flowsheet/master_flowsheet.py → ...rkspace/UKy_flowsheet/master_flowsheet.py b/UKy_flowsheet/master_flowsheet.py → ...rkspace/UKy_flowsheet/master_flowsheet.py
@@ -46,21 +46,21 @@
 )
 from idaes.core.util.model_statistics import degrees_of_freedom
 
-from workspace.UKy_flowsheet.old_leaching.leach_solution_properties import LeachSolutionParameters
-from workspace.UKy_flowsheet.old_leaching.leach_solids_properties import CoalRefuseParameters
-from workspace.UKy_flowsheet.old_leaching.leach_reactions import CoalRefuseLeachingReactions
+from prommis_workspace.UKy_flowsheet.old_leaching.leach_solution_properties import LeachSolutionParameters
+from prommis_workspace.UKy_flowsheet.old_leaching.leach_solids_properties import CoalRefuseParameters
+from prommis_workspace.UKy_flowsheet.old_leaching.leach_reactions import CoalRefuseLeachingReactions
 
-from workspace.Solvent_Extraction.REESXmodel import REESX
-from workspace.Solvent_Extraction.REEAqdistribution import REESolExAqParameters
-from workspace.Solvent_Extraction.REEOgdistribution import REESolExOgParameters
+from prommis_workspace.Solvent_Extraction.REESXmodel import REESX
+from prommis_workspace.Solvent_Extraction.REEAqdistribution import REESolExAqParameters
+from prommis_workspace.Solvent_Extraction.REEOgdistribution import REESolExOgParameters
 
-from workspace.precipitate.precipitator import Precipitator
-from workspace.precipitate.precip_prop import AqueousStateParameterBlock, PrecipitateStateParameterBlock
+from prommis_workspace.precipitate.precipitator import Precipitator
+from prommis_workspace.precipitate.precip_prop import AqueousStateParameterBlock, PrecipitateStateParameterBlock
 
-from workspace.roasting.ree_oxalate_roster import REEOxalateRoaster
+from prommis_workspace.roasting.ree_oxalate_roster import REEOxalateRoaster
 
-from workspace.UKy_flowsheet.Translators.translator_leaching_SX import Translator_leaching_SX
-from workspace.UKy_flowsheet.Translators.translator_SX_precipitator import Translator_SX_precipitator
+from prommis_workspace.UKy_flowsheet.Translators.translator_leaching_SX import Translator_leaching_SX
+from prommis_workspace.UKy_flowsheet.Translators.translator_SX_precipitator import Translator_SX_precipitator
 
 from idaes.models.properties.modular_properties.base.generic_property import (
     GenericParameterBlock,

diff --git a/...flowsheet/old_leaching/leach_flowsheet.py → ...flowsheet/old_leaching/leach_flowsheet.py b/...flowsheet/old_leaching/leach_flowsheet.py → ...flowsheet/old_leaching/leach_flowsheet.py
diff --git a/...flowsheet/old_leaching/leach_reactions.py → ...flowsheet/old_leaching/leach_reactions.py b/...flowsheet/old_leaching/leach_reactions.py → ...flowsheet/old_leaching/leach_reactions.py
diff --git a/...t/old_leaching/leach_solids_properties.py → ...t/old_leaching/leach_solids_properties.py b/...t/old_leaching/leach_solids_properties.py → ...t/old_leaching/leach_solids_properties.py
diff --git a/...old_leaching/leach_solution_properties.py → ...old_leaching/leach_solution_properties.py b/...old_leaching/leach_solution_properties.py → ...old_leaching/leach_solution_properties.py
diff --git a/roasting/feed_roaster_flowsheet.py → ...kspace/roasting/feed_roaster_flowsheet.py b/roasting/feed_roaster_flowsheet.py → ...kspace/roasting/feed_roaster_flowsheet.py
diff --git a/roasting/oxalate_roaster_flowsheet.py → ...ace/roasting/oxalate_roaster_flowsheet.py b/roasting/oxalate_roaster_flowsheet.py → ...ace/roasting/oxalate_roaster_flowsheet.py
diff --git a/roasting/ree_feed_roster.py → ...mis_workspace/roasting/ree_feed_roster.py b/roasting/ree_feed_roster.py → ...mis_workspace/roasting/ree_feed_roster.py
diff --git a/roasting/ree_oxalate_roster.py → ..._workspace/roasting/ree_oxalate_roster.py b/roasting/ree_oxalate_roster.py → ..._workspace/roasting/ree_oxalate_roster.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,104 @@
+[build-system]
+requires = [
+    "setuptools>=61",
+    "wheel",
+    "setuptools_scm[toml]"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+    name = "prommis_workspace"
+    description = "prommis workspace"
+    readme = "README.md"
+    version = "0.23.11" #Version format 0.YY.MM
+    license = {text="BSD"}
+    requires-python = ">=3.8"
+    authors = [
+        {name="The Prommis Project"}
+    ]
+    classifiers = [
+            "Development Status :: 3 - Alpha",
+            "Intended Audience :: End Users/Desktop",
+            "Intended Audience :: Science/Research",
+            "License :: OSI Approved :: BSD License",
+            "Natural Language :: English",
+            "Operating System :: MacOS",
+            "Operating System :: Microsoft :: Windows",
+            "Operating System :: Unix",
+            "Programming Language :: Python",
+            "Programming Language :: Python :: 3",
+            "Programming Language :: Python :: 3.8",
+            "Programming Language :: Python :: 3.9",
+            "Programming Language :: Python :: 3.10",
+            "Programming Language :: Python :: 3.11",
+            "Programming Language :: Python :: Implementation :: CPython",
+            "Topic :: Scientific/Engineering :: Mathematics",
+            "Topic :: Scientific/Engineering :: Chemistry",
+            "Topic :: Software Development :: Libraries :: Python Modules",
+    ]
+    dependencies = [
+        # Don't version setuptools, various bits complain
+        "setuptools",
+        # For running tests
+        "pytest",
+    ]
+    keywords = ["IDAES", "energy systems", "chemical engineering", "process modeling"]
+
+[project.optional-dependencies]
+# Just for developers (they should also add 'jb')
+dev = [
+    # For adding copyright headers (see addheader.yml and the readme)
+    "addheader >= 0.3.0",
+    # Dev versions of idaes/idaes-ui
+    # Not handled by the toml file yet, see requirements-dev.txt
+    #"git+https://github.com/idaes/idaes-pse.git@main",
+    #"git+https://github.com/IDAES/idaes-ui.git@main"
+]
+# For packaging
+pkg = [
+    "build",
+    "twine"
+]
+
+[project.urls]
+github = "https://github.com/prommis/workspace"
+issues = "https://github.com/prommis/workspace/issues"
+
+[tool.setuptools]
+include-package-data = true
+zip-safe = false
+
+[tool.setuptools.packages]
+find = {namespaces = false}
+
+[tool.setuptools.package-data]
+prommis = [
+    "*.template",
+    "*.json",
+    "*.yaml",
+    "*.svg",
+    "*.png",
+    "*.jpg",
+    "*.csv",
+    "*.ipynb",
+    "*.txt",
+    "*.js",
+    "*.css",
+    "*.html",
+    "*.json.gz",
+    "*.dat",
+    "*.yml",
+    "*.yaml",
+]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra"
+testpaths = [
+    "prommis_workspace"
+]
+markers = [
+    "component: between unit and integration test",
+    "unit: test one small unit of functionality",
+    "integration: test integrated functionality"
+]
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,5 @@
+# install req
+git+https://github.com/idaes/idaes-pse.git@main
+git+https://github.com/IDAES/idaes-ui.git@main
+
+-e .[dev]