Merge pull request #1 from regislon/main

add packaging pipeline
transp-or · Oct 2, 2023 · 56cbff2 · 56cbff2
2 parents db2295e + e0e00cb
commit 56cbff2
Show file tree

Hide file tree

Showing 47 changed files with 254 additions and 14 deletions.
diff --git a/.github/workflows/release_to_pypi.yml b/.github/workflows/release_to_pypi.yml
@@ -0,0 +1,49 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+on: push
+
+jobs: 
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/oasisis 
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/code/__pycache__/activity.cpython-310.pyc b/code/__pycache__/activity.cpython-310.pyc
diff --git a/code/__pycache__/activity.cpython-37.pyc b/code/__pycache__/activity.cpython-37.pyc
diff --git a/code/__pycache__/data_utils.cpython-310.pyc b/code/__pycache__/data_utils.cpython-310.pyc
diff --git a/code/__pycache__/data_utils.cpython-37.pyc b/code/__pycache__/data_utils.cpython-37.pyc
diff --git a/code/__pycache__/error_terms.cpython-310.pyc b/code/__pycache__/error_terms.cpython-310.pyc
diff --git a/code/__pycache__/error_terms.cpython-37.pyc b/code/__pycache__/error_terms.cpython-37.pyc
diff --git a/code/__pycache__/estimation.cpython-310.pyc b/code/__pycache__/estimation.cpython-310.pyc
diff --git a/code/__pycache__/estimation.cpython-37.pyc b/code/__pycache__/estimation.cpython-37.pyc
diff --git a/code/__pycache__/helper_func.cpython-310.pyc b/code/__pycache__/helper_func.cpython-310.pyc
diff --git a/code/__pycache__/helper_func.cpython-37.pyc b/code/__pycache__/helper_func.cpython-37.pyc
diff --git a/code/__pycache__/input_data.cpython-310.pyc b/code/__pycache__/input_data.cpython-310.pyc
diff --git a/code/__pycache__/input_data.cpython-37.pyc b/code/__pycache__/input_data.cpython-37.pyc
diff --git a/code/__pycache__/metropolis_hastings.cpython-310.pyc b/code/__pycache__/metropolis_hastings.cpython-310.pyc
diff --git a/code/__pycache__/metropolis_hastings.cpython-37.pyc b/code/__pycache__/metropolis_hastings.cpython-37.pyc
diff --git a/code/__pycache__/operators.cpython-310.pyc b/code/__pycache__/operators.cpython-310.pyc
diff --git a/code/__pycache__/operators.cpython-37.pyc b/code/__pycache__/operators.cpython-37.pyc
diff --git a/code/__pycache__/preprocessing.cpython-310.pyc b/code/__pycache__/preprocessing.cpython-310.pyc
diff --git a/code/__pycache__/results.cpython-310.pyc b/code/__pycache__/results.cpython-310.pyc
diff --git a/code/__pycache__/results.cpython-37.pyc b/code/__pycache__/results.cpython-37.pyc
diff --git a/code/__pycache__/runner.cpython-310.pyc b/code/__pycache__/runner.cpython-310.pyc
diff --git a/code/__pycache__/runner.cpython-37.pyc b/code/__pycache__/runner.cpython-37.pyc
diff --git a/code/__pycache__/runner_estimation.cpython-310.pyc b/code/__pycache__/runner_estimation.cpython-310.pyc
diff --git a/code/__pycache__/runner_estimation.cpython-37.pyc b/code/__pycache__/runner_estimation.cpython-37.pyc
diff --git a/code/__pycache__/runner_multiday.cpython-310.pyc b/code/__pycache__/runner_multiday.cpython-310.pyc
diff --git a/code/__pycache__/runner_multiday.cpython-37.pyc b/code/__pycache__/runner_multiday.cpython-37.pyc
diff --git a/code/__pycache__/settings.cpython-310.pyc b/code/__pycache__/settings.cpython-310.pyc
diff --git a/code/__pycache__/settings.cpython-37.pyc b/code/__pycache__/settings.cpython-37.pyc
diff --git a/code/__pycache__/simulation.cpython-310.pyc b/code/__pycache__/simulation.cpython-310.pyc
diff --git a/code/__pycache__/simulation.cpython-37.pyc b/code/__pycache__/simulation.cpython-37.pyc
diff --git a/gitignore b/gitignore
@@ -0,0 +1,156 @@
+# Don't track these files
+
+*~
+.DS_Store
+.vscode
+.Rhistory
+
+# Folders
+/dask-worker-space/
+/data/DISDRODB/Processed
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+_version.py
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/source/api
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+/venv/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+*.bkp
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+train_interactive.py
+tmp_fig.py
+log.txt
diff --git a/code/activity.py → oasisis/activity.py b/code/activity.py → oasisis/activity.py
diff --git a/code/data_utils.py → oasisis/data_utils.py b/code/data_utils.py → oasisis/data_utils.py
diff --git a/code/error_terms.py → oasisis/error_terms.py b/code/error_terms.py → oasisis/error_terms.py
diff --git a/code/estimation.py → oasisis/estimation.py b/code/estimation.py → oasisis/estimation.py
diff --git a/code/helper_func.py → oasisis/helper_func.py b/code/helper_func.py → oasisis/helper_func.py
diff --git a/code/input_data.py → oasisis/input_data.py b/code/input_data.py → oasisis/input_data.py
diff --git a/code/metropolis_hastings.py → oasisis/metropolis_hastings.py b/code/metropolis_hastings.py → oasisis/metropolis_hastings.py
diff --git a/code/operators.py → oasisis/operators.py b/code/operators.py → oasisis/operators.py
diff --git a/code/results.py → oasisis/results.py b/code/results.py → oasisis/results.py
diff --git a/code/runner.py → oasisis/runner.py b/code/runner.py → oasisis/runner.py
diff --git a/code/runner_estimation.py → oasisis/runner_estimation.py b/code/runner_estimation.py → oasisis/runner_estimation.py
diff --git a/code/runner_multiday.py → oasisis/runner_multiday.py b/code/runner_multiday.py → oasisis/runner_multiday.py
diff --git a/code/settings.py → oasisis/settings.py b/code/settings.py → oasisis/settings.py
diff --git a/code/simulation.py → oasisis/simulation.py b/code/simulation.py → oasisis/simulation.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools>=61.0", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "oasisis"
+authors = [
+	{name = "Janody Pougala",email = "janody.pougala@epfl.ch"},
+]
+description = "This is a stable version of the OASIS activity-based framework. This repository includes the simulation code, based on the Python API of the CPLEX solver."
+readme = "README.md"
+keywords = ["python", "disdrometer"]
+classifiers = [
+	"Development Status :: 1 - Planning",
+	"Intended Audience :: Developers",
+	"Programming Language :: Python :: 3",
+	"Operating System :: Unix",
+	"Operating System :: MacOS :: MacOS X",
+	"Operating System :: Microsoft :: Windows",
+]
+requires-python = ">=3.8"
+dependencies = [
+	"click",
+	"cplex",
+	"docplex",
+	"joblib",
+	"json5",
+	"jsonschema",
+	"matplotlib",
+	"numpy",
+	"ortools",
+	"pandas",
+	"python-dateutil",
+	"python-json-logger",
+	"scipy",
+	"seaborn",
+	"geopy"
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+]
+
+[tool.setuptools_scm]
+write_to = "oasisis/_version.py"
+
+[tool.setuptools]
+packages = ["oasisis"]
diff --git a/requirements.txt b/requirements.txt