enbid-ananke 0.3.1__py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

enbid_ananke/__metadata__.py

@@ -0,0 +1,160 @@
+#!/usr/bin/env python
+"""
+Contains the EnBiD module metadata.
+"""
+import _sitebuiltins
+import textwrap
+from typing import Final
+from datetime import datetime
+
+from . import _version
+
+try:
+    from .__license__ import __license_full__
+except ImportError:
+    __license_full__ = ""
+
+__all__ = ['__project__', '__description__', '__url__', '__year__', '__author__', '__contributors__', '__license__',
+           '__version__', '__date__', '__maintainer__', '__email__', '__classifiers__',
+           '__credits__', '__doi__', '__citation__', '__adsurl__', '__bibtex__', '__copyright__', '__readme__',
+           'copyright', 'credits', 'license', 'readme']
+
+# PROJECT METADATA
+__project__ = "py-EnBiD-ananke"
+__description__ = "Python wrapper for EnBiD (Sharma & Steinmetz 2011 <http://ascl.net/1109.012>) for py-ananke <https://github.com/athob/py-ananke>."
+__url__ = "https://github.com/athob/py-EnBiD-ananke"
+__year__ = 2022
+__author__ = "Adrien Thob"
+__contributors__ = ["Robyn Sanderson", "Andrew Eden"]
+__supporters__ = ["Sanjib Sharma"]
+__feedback__ = ["the extended Galaxy Dynamics @ UPenn group", "the participants of the \"anankethon\" workshops"]
+__license__ = "GNU General Public License v2 or later (GPLv2+)"  # TODO change to longer version?
+__license_classifier__ = "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)"
+__license_short__ = "Licensed under the GNU GPL v2 or later"
+
+# SOFTWARE METADATA
+__version__: Final[str] = _version.get_versions()['version']
+__date__: str = _version.get_versions()['date']
+__date__: datetime = datetime.fromisoformat(f"{__date__[:-2]}:{__date__[-2:]}")
+__maintainer__ = "Adrien Thob"
+__email__ = "athob@sas.upenn.edu"
+__status_classifier__ = "Development Status :: 5 - Production/Stable"
+__classifiers__ = [
+    __status_classifier__,
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    __license_classifier__,
+    "Natural Language :: English",
+    "Operating System :: Unix",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Astronomy"
+    ]
+
+# CREDITS METADATA
+__credits__ = textwrap.fill(f"""
+Thanks to {', '.join(__contributors__)[::-1].replace(',','& ', 1)[::-1]} for their contributions,
+to {', '.join(__supporters__)[::-1].replace(',','& ', 1)[::-1]} for their support & guidance,
+and to the wider community for their suggestions and feedback,
+including {', '.join(__feedback__)[::-1].replace(',','& ', 1)[::-1]}.
+""".strip('\n'))
+
+# CITING METADATA
+__doi__ = "10.21105/joss.06234"
+__citation__ = textwrap.fill("""
+Thob, Adrien C. R. et al. 2024, “Generating synthetic star catalogs
+from simulated data for next-gen observatories with py-ananke”,
+The Journal of Open Source Software, 9, 6234, doi:10.21105/joss.06234.
+""".strip('\n'))
+__adsurl__ = "https://ui.adsabs.harvard.edu/abs/2024JOSS....9.6234T"
+__adsexportcitation__ = f"{__adsurl__}/exportcitation"
+__bibtex__ = """
+@ARTICLE{2024JOSS....9.6234T,
+       author = {{Thob}, Adrien C.~R. and {Sanderson}, Robyn E. and
+       {Eden}, Andrew P. and {Nikakhtar}, Farnik and
+       {Panithanpaisal}, Nondh and {Garavito-Camargo}, Nicol{\\'a}s
+       and {Sharma}, Sanjib},
+        title = "{Generating synthetic star catalogs from simulated data
+        for next-gen observatories with py-ananke}",
+      journal = {The Journal of Open Source Software},
+     keywords = {C++, astronomy, galaxies, stars, simulations,
+          mock observations, Jupyter Notebook, Python,
+          Astrophysics - Astrophysics of Galaxies,
+          Astrophysics - Instrumentation and Methods for Astrophysics},
+         year = 2024,
+        month = oct,
+       volume = {9},
+       number = {102},
+          eid = {6234},
+        pages = {6234},
+          doi = {10.21105/joss.06234},
+archivePrefix = {arXiv},
+       eprint = {2312.02268},
+ primaryClass = {astro-ph.GA},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024JOSS....9.6234T},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}
+""".strip('\n')
+__citing__ = '\n\n'.join(map(textwrap.fill, f"""
+If {__project__} has played a role in your research project or software
+development, we kindly request that you acknowledge and cite the
+project. Citing {__project__} not only gives credit to the dedicated
+efforts of its creators but also helps others discover and benefit
+from this software.
+
+To cite {__project__}, please use DOI {__doi__} as a
+reference in your publications, or cite as the following:
+
+{{__citation__}}
+
+Alternatively, you may use one of the entries associated with
+{__project__} as listed by The SAO/NASA Astrophysics Data System:
+<{__adsexportcitation__}>
+such as the following BibTeX entry:
+
+{{__bibtex__}}
+""".strip('\n').split('\n\n'))).format(__citation__=__citation__, __bibtex__=__bibtex__)
+
+# COPYRIGHT METADATA
+__copyright_short__ = f"Copyright (C) {__year__}-{__date__.year}  {__author__}"
+__copyright__ = f"""
+{textwrap.fill(f"{__project__} v{__version__}: {__description__}")}
+
+{__copyright_short__}
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+--CITING-------------------------------------------------------------
+
+{__citing__}
+""".strip('\n')
+
+# README
+__readme__ = f"""
+{__copyright__}
+
+--CREDITS------------------------------------------------------------
+
+{__credits__}
+""".strip('\n')
+
+# DEFINING PRINTERS
+copyright = _sitebuiltins._Printer('copyright', __copyright__)
+credits = _sitebuiltins._Printer('credits', __credits__)
+license = _sitebuiltins._Printer('license', __license_full__)
+readme = _sitebuiltins._Printer('readme', __readme__)
+
+
+if __name__ == '__main__':
+    raise NotImplementedError()

enbid_ananke/_builtin_utils.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python
+"""
+Module utilities using built-in implementation
+"""
+import sys
+from types import ModuleType
+import subprocess
+import importlib.util
+import re
+
+__all__ = ['Singleton', 'execute', 'get_version_of_command', 'import_source_file']
+
+
+class Singleton(type):
+    """
+    Singleton metaclass.
+    Credit https://stackoverflow.com/q/6760685
+    """
+    _instances = {}
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
+        return cls._instances[cls]
+
+
+def _execute_generator(args, **kwargs):
+    popen = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True, **kwargs)
+    for stdout_line in iter(popen.stdout.readline, ""):
+        yield stdout_line 
+    popen.stdout.close()
+    return_code = popen.wait()
+    if return_code:
+        raise subprocess.CalledProcessError(return_code, args)
+
+
+def execute(args, verbose=True, **kwargs):
+    """
+    Run the command described by args, and use
+    verbose kwarg to redirect output/error stream
+    to python output stream.
+    Credit https://stackoverflow.com/a/4417735
+    """
+    for path in _execute_generator(args, **kwargs):
+        print(path, end="") if verbose else None
+
+
+def get_version_of_command(cmd):
+    return re.findall("((?:[0-9]+\.)+[0-9]+)",
+                      str(subprocess.check_output([cmd, '--version'])))[0]
+
+
+def import_source_file(module_name, file_path) -> ModuleType:
+    # based on https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
+    spec = importlib.util.spec_from_file_location(module_name, file_path)
+    module = importlib.util.module_from_spec(spec)
+    sys.modules[module_name] = module
+    spec.loader.exec_module(module)
+    return module
+
+
+if __name__ == '__main__':
+    raise NotImplementedError()

enbid_ananke/_constants.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+"""
+Contains the EnBiD module constants.
+"""
+import pathlib
+from dataclasses import dataclass
+
+from ._name import *
+from ._builtin_utils import Singleton
+
+__all__ = ['NAME', 'LOG_DIR', 'SRC_DIR', 'ENBID_URL', 'CONSTANTS', 'SNAPSHOT_FILEBASE', 'ENBID_OUT_EXT', 'HASH_EXT', 'HASH_ENCODING']
+
+ENBID2 = 'Enbid-2.0'
+ENBID_URL = 'https://sourceforge.net/projects/enbid/files/latest/download'
+ENBID_EXEC = 'Enbid'
+LOG_DIR = 'log'
+SRC_DIR = 'src'
+
+ENBID_PARAMFILE = 'enbid_paramfile'
+USEDVALUES_SUFFIX = '_enbid-usedvalues'
+SNAPSHOT_FILEBASE = 'SnapshotFileBase'
+ENBID_OUT_EXT = 'est'
+HASH_EXT = 'hash'
+HASH_ENCODING = 'ascii'
+
+@dataclass()
+class Constants(metaclass=Singleton):
+    enbid2: str          = ENBID2
+    enbid_exec: str      = ENBID_EXEC
+    _enbid: pathlib.Path = None
+    enbid_paramfile: str = ENBID_PARAMFILE
+
+    @property
+    def enbid_cpp(self):
+        return pathlib.Path(__file__).resolve().parent / self.enbid2
+    
+    @property
+    def enbid(self):
+        if isinstance(self._enbid, pathlib.Path):
+            return self._enbid
+        else:
+            return self.enbid_cpp / self.enbid_exec
+    
+    @enbid.setter
+    def enbid(self, path: pathlib.Path):
+        self._enbid = path
+
+    @property
+    def usedvalues(self):
+        return f"{self.enbid_paramfile}{USEDVALUES_SUFFIX}"
+
+CONSTANTS = Constants()
+
+
+if __name__ == '__main__':
+    raise NotImplementedError()

enbid_ananke/_defaults.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+"""
+Contains the EnBiD module defaults.
+"""
+import tempfile
+
+from ._templates import *
+
+__all__ = ['DEFAULT_NGB', 'DEFAULT_FOR_PARAMFILE']
+
+TO_ENBID_FILENAME = 'to_enbid'
+DEFAULT_NGB = 64
+
+DEFAULT_FOR_PARAMFILE = {
+    TTAGS.fname: TO_ENBID_FILENAME,
+    # TTAGS.des_num_ngb: DEFAULT_NGB,
+    TTAGS.spatial_scale: 1.0,
+    TTAGS.part_boundary: 7,
+    TTAGS.node_splitting_criterion: 1,
+    TTAGS.cubic_cells: 0,
+    TTAGS.median_splitting_on: 1,
+    TTAGS.type_of_smoothing: 3,
+    TTAGS.vol_corr: 1,
+    TTAGS.type_of_kernel: 3,
+    TTAGS.kernel_bias_correction: 1,
+    TTAGS.anisotropy_kernel: 0,
+    TTAGS.anisotropy: 0,
+    TTAGS.type_list_on: 0,
+    TTAGS.periodic_boundary_on: 0
+}
+
+TEMP_DIR = tempfile.TemporaryDirectory()
+
+
+if __name__ == '__main__':
+    raise NotImplementedError()

enbid_ananke/_name.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+"""
+"""
+__all__ = ['NAME']
+
+NAME = 'enbid_ananke'
+
+
+if __name__ == '__main__':
+    raise NotImplementedError()

enbid_ananke/_templates.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+"""
+Contains the EnBiD module templates.
+"""
+from string import Template
+from dataclasses import dataclass
+
+from ._builtin_utils import Singleton
+
+__all__ = ['TTAGS', 'ENBID_PARAMFILE_TEMPLATE']
+
+@dataclass(frozen=True)
+class TemplateTags(metaclass=Singleton):
+    fname: str                    = 'fname'
+    des_num_ngb: str              = 'des_num_ngb'
+    spatial_scale: str            = 'spatial_scale'
+    part_boundary: str            = 'part_boundary'
+    node_splitting_criterion: str = 'node_splitting_criterion'
+    cubic_cells: str              = 'cubic_cells'
+    median_splitting_on: str      = 'median_splitting_on'
+    type_of_smoothing: str        = 'type_of_smoothing'
+    vol_corr: str                 = 'vol_corr'
+    type_of_kernel: str           = 'type_of_kernel'
+    kernel_bias_correction: str   = 'kernel_bias_correction'
+    anisotropy_kernel: str        = 'anisotropy_kernel'
+    anisotropy: str               = 'anisotropy'
+    des_num_ngb_a: str            = 'des_num_ngb_a'
+    type_list_on: str             = 'type_list_on'
+    periodic_boundary_on: str     = 'periodic_boundary_on'
+
+TTAGS = TemplateTags()
+
+ENBID_PARAMFILE_TEMPLATE = Template(f"""%  Input and Output
+InitCondFile     ${{{TTAGS.fname}}}
+
+%-------------------------------------------------------
+ICFormat                  0     % O)ASCII 1)Gadget 2)User defined
+SnapshotFileBase        _d3n${{{TTAGS.des_num_ngb}}}
+
+%-------------------------------------------------------
+% Tree related options
+SpatialScale            ${{{TTAGS.spatial_scale}}}   % x->x/SpatialScale and v->v
+PartBoundary            ${{{TTAGS.part_boundary}}}   % Min particles in a node to do boundary correction
+NodeSplittingCriterion  ${{{TTAGS.node_splitting_criterion}}}   % 0)Alternate 1) Min Entropy
+CubicCells              ${{{TTAGS.cubic_cells}}}   % use 1 in spherically symmetric systems
+MedianSplittingOn       ${{{TTAGS.median_splitting_on}}}
+
+%--------------------------------------------------------
+% Smoothing options  AM=adaptive metric Ker=Kernel Sp=Spherical Pr=Product
+% 0) None 1)FiEstAS 2)Ker Sp Normal 3)Ker Sp AM 4)KerPr Normal 5)KerPr AM
+TypeOfSmoothing      ${{{TTAGS.type_of_smoothing}}}
+DesNumNgb            ${{{TTAGS.des_num_ngb}}}   % 2-10 for Fiestas and 25-100 for Kernel
+VolCorr              ${{{TTAGS.vol_corr}}}    %  0) Disbale 1) Enable
+
+%--------------------------------------------------------
+% Kernel smoothing  related options
+% 0) B-Spline 1)top hat 2)Bi_weight (1-x^2)^2 3)Epanechikov 4)CIC 5)TSC
+TypeOfKernel           ${{{TTAGS.type_of_kernel}}}
+KernelBiasCorrection   ${{{TTAGS.kernel_bias_correction}}}    % 0)none 1)shift central particle
+AnisotropicKernel      ${{{TTAGS.anisotropy_kernel}}}    % 0) Isotropic 1) Anisotropic
+Anisotropy             ${{{TTAGS.anisotropy}}}    % fix minimum c/a minor/major axis ratio
+DesNumNgbA             ${{{TTAGS.des_num_ngb_a}}}   % Neighbors for cal covar metric for Anisotropic Ker
+%--------------------------------------------------------
+% other miscellaneous option
+TypeListOn        ${{{TTAGS.type_list_on}}}
+PeriodicBoundaryOn ${{{TTAGS.periodic_boundary_on}}}
+%--------------------------------------------------------""")
+
+
+if __name__ == '__main__':
+    raise NotImplementedError()

enbid_ananke/_version.py

@@ -0,0 +1,21 @@
+
+# This file was generated by 'versioneer.py' (0.29) from
+# revision-control system data, or from the parent directory name of an
+# unpacked source archive. Distribution tarballs contain a pre-generated copy
+# of this file.
+
+import json
+
+version_json = '''
+{
+ "date": "2025-06-27T18:26:14-0400",
+ "dirty": false,
+ "error": null,
+ "full-revisionid": "88fd859a1d0a1491f3b68091c84388493eaa9d47",
+ "version": "0.3.1"
+}
+'''  # END VERSION_JSON
+
+
+def get_versions():
+    return json.loads(version_json)

enbid_ananke/utils.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+"""
+Module miscellaneous utilities
+"""
+from enbid_ananke._builtin_utils import Singleton, execute
+
+__all__ = ['Singleton', 'execute']
+
+
+if __name__ == '__main__':
+    raise NotImplementedError()