graphical-sampling 0.1.0__tar.gz

graphical_sampling-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# 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
+
+# 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/
+
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# ruff
+.ruff_cache
+
+
+.idea
+.envrc
+
+temp_*
+*.png
+
+.DS_Store

graphical_sampling-0.1.0/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

graphical_sampling-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mehdi Mohebbi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

graphical_sampling-0.1.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: graphical-sampling
+Version: 0.1.0
+Summary: Python package for Graphical Sampling Method
+Author-email: Bardia Panahbehagh <bardia.panah@gmail.com>, Mehdi Mohebbi <mehdi.mohebbi23@gmail.com>, AmirMohammad HosseiniNasab <awmirhn@gmail.com>, Mehdi Hosseini Moghadam <m.h.moghadam1996@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: k-means-constrained>=0.7.5
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: package-sampling>=0.3.0
+Requires-Dist: pandas
+Requires-Dist: scikit-learn
+Requires-Dist: scipy
+Description-Content-Type: text/markdown
+
+
+# Graphical Sampling Method - Python Package
+
+The Graphical Sampling Method, introduced by Panahbehagh (2025), presents an innovative approach to finite population sampling based on a unique graphical framework. This method allows researchers to visually depict first-order inclusion probabilities (FIP) as bars on a two-dimensional graph. By adjusting the positions of these bars, users can explore a wide range of sampling designs while controlling second-order inclusion probabilities (SIP).
+
+This package, `graphical_sampling`, provides tools for implementing the Graphical Sampling Method and is available on PyPI.
+
+---
+
+## Features
+- Create various unequal probability sampling designs with a fixed FIP.
+- Control and explore second-order inclusion probabilities (SIP) through visual manipulation.
+- Incorporate search algorithms, such as A* and Genetic Algorithm, to optimize sampling designs for specific needs (e.g., well-spread or optimal sampling).
+
+## Installation
+
+Install the package via pip:
+```bash
+pip install graphical_sampling
+```
+
+## How to Use
+
+The package includes core classes and methods to facilitate sampling design creation and optimization. Below is a basic example demonstrating the API.
+
+### Example Usage
+
+```python
+import graphical_sampling as gs
+import numpy as np
+
+# Set up random generator and sample data
+rng = np.random.default_rng()
+N = 50  # Population size
+x = rng.random(size=N)  # Auxiliary variable
+n = 5  # Sample size
+
+# Generate initial inclusion probabilities
+inclusion = rng.random(N)
+inclusion *= n / inclusion.sum()
+
+# Define initial sampling design and evaluation criteria
+initial_design = gs.Design(inclusion)
+nht = gs.criteria.VarNHT(x, inclusion)
+astar = gs.search.AStar(initial_design, nht, switch_coefficient=1)
+
+# Display initial criteria and design
+print("Initial criteria value:", astar.initial_criteria_value)
+astar.initial_design.show()
+
+# Run the A* search algorithm to optimize the design
+astar.run(max_iterations=2000, num_new_nodes=10, max_open_set_size=10000, num_changes=1)
+
+# Display results after optimization
+print("Best criteria value:", astar.best_criteria_value)
+astar.best_design.show()
+```
+
+
+## Maintainers
+
+- Bardia Panahbehagh - [bardia.panah@gmail.com](mailto:bardia.panah@gmail.com)
+- Mehdi Mohebbi - [mehdi.mohebbi23@gmail.com](mailto:mehdi.mohebbi23@gmail.com)
+- AmirMohammad HosseiniNasab - [awmirhn@gmail.com](mailto:awmirhn@gmail.com)
+- Mehdi Hosseini Moghadam - [m.h.moghadam1996@gmail.com](mailto:m.h.moghadam1996@gmail.com)
+
+---
+
+For more details, consult the official paper: Panahbehagh, B. (2025). Graphical Sampling Method.

graphical_sampling-0.1.0/README.md

@@ -0,0 +1,69 @@
+
+# Graphical Sampling Method - Python Package
+
+The Graphical Sampling Method, introduced by Panahbehagh (2025), presents an innovative approach to finite population sampling based on a unique graphical framework. This method allows researchers to visually depict first-order inclusion probabilities (FIP) as bars on a two-dimensional graph. By adjusting the positions of these bars, users can explore a wide range of sampling designs while controlling second-order inclusion probabilities (SIP).
+
+This package, `graphical_sampling`, provides tools for implementing the Graphical Sampling Method and is available on PyPI.
+
+---
+
+## Features
+- Create various unequal probability sampling designs with a fixed FIP.
+- Control and explore second-order inclusion probabilities (SIP) through visual manipulation.
+- Incorporate search algorithms, such as A* and Genetic Algorithm, to optimize sampling designs for specific needs (e.g., well-spread or optimal sampling).
+
+## Installation
+
+Install the package via pip:
+```bash
+pip install graphical_sampling
+```
+
+## How to Use
+
+The package includes core classes and methods to facilitate sampling design creation and optimization. Below is a basic example demonstrating the API.
+
+### Example Usage
+
+```python
+import graphical_sampling as gs
+import numpy as np
+
+# Set up random generator and sample data
+rng = np.random.default_rng()
+N = 50  # Population size
+x = rng.random(size=N)  # Auxiliary variable
+n = 5  # Sample size
+
+# Generate initial inclusion probabilities
+inclusion = rng.random(N)
+inclusion *= n / inclusion.sum()
+
+# Define initial sampling design and evaluation criteria
+initial_design = gs.Design(inclusion)
+nht = gs.criteria.VarNHT(x, inclusion)
+astar = gs.search.AStar(initial_design, nht, switch_coefficient=1)
+
+# Display initial criteria and design
+print("Initial criteria value:", astar.initial_criteria_value)
+astar.initial_design.show()
+
+# Run the A* search algorithm to optimize the design
+astar.run(max_iterations=2000, num_new_nodes=10, max_open_set_size=10000, num_changes=1)
+
+# Display results after optimization
+print("Best criteria value:", astar.best_criteria_value)
+astar.best_design.show()
+```
+
+
+## Maintainers
+
+- Bardia Panahbehagh - [bardia.panah@gmail.com](mailto:bardia.panah@gmail.com)
+- Mehdi Mohebbi - [mehdi.mohebbi23@gmail.com](mailto:mehdi.mohebbi23@gmail.com)
+- AmirMohammad HosseiniNasab - [awmirhn@gmail.com](mailto:awmirhn@gmail.com)
+- Mehdi Hosseini Moghadam - [m.h.moghadam1996@gmail.com](mailto:m.h.moghadam1996@gmail.com)
+
+---
+
+For more details, consult the official paper: Panahbehagh, B. (2025). Graphical Sampling Method.