fedverse 0.0.1__tar.gz

fedverse-0.0.1/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 William Rubio
+
+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.

fedverse-0.0.1/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE.md
+include src/fedverse/README.md
+include src/fedverse/extracted/PROVENANCE.md
+include src/fedverse/extracted/LICENSE.*
+recursive-include src/fedverse/fedassets *.png *.svg *.jpg *.jpeg
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

fedverse-0.0.1/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: fedverse
+Version: 0.0.1
+Summary: FED3 multi-assay analysis pipeline (SSPsyGene)
+Home-page: https://github.com/willbrubio/fedverse
+Author: William Rubio
+Author-email: bernard.william@gmail.com
+License: MIT
+Project-URL: Source, https://github.com/willbrubio/fedverse
+Project-URL: Issues, https://github.com/willbrubio/fedverse/issues
+Keywords: FED3,neuroscience,behavior,operant,SSPsyGene
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+License-File: src/fedverse/extracted/LICENSE.fed3
+License-File: src/fedverse/extracted/LICENSE.fed3bandit
+Requires-Dist: pandas<3
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: seaborn
+Requires-Dist: statsmodels
+Requires-Dist: pingouin
+Requires-Dist: tqdm
+Requires-Dist: ipywidgets
+Requires-Dist: ipython
+Requires-Dist: openpyxl
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# fedverse
+
+The purpose of fedverse is to create a unifying package of libraries that concern themselves with the analysis of FED devices in conjunction with the established workflow for the SSPsyGene project. Currently, fedverse inherits functions from fed3bandit written by Alex Legaria (https://fed3bandit.readthedocs.io/en/latest/analysis/fed3live_api.html) and the fed3 library written by Tom Earnest (https://earnestt1234.github.io/fed3/fed3/index.html). Additionally, this library includes code written for FED3Analyses by Chantelle Murrell (https://github.com/KravitzLab/FED3Analyses). 
+
+This library was created for the intention of of automating a analysis pipeline for the WUSMAC SSPsyGene analysis of FED devices. 
+
+The pipeline created by this library is meant to ingest L1 files alongside their key file and automate the process of creating an L4. Anything besides that functionality is outside the scope of the intended pipeline. 
+
+
+## Sub Library Architecture
+This library consists of sub libraries in this specific heiarchy:
+```
+├──extracted
+|   ├──fed3_fedframe.py
+|   ├──fed3_loading.py
+|   └──fed3bandit_extracted.py
+├──fedassays
+|   ├──fedbandit.py
+|   ├──fedpr1.py
+|   └──fedfr1.py
+├──fedassets
+├──fedcore
+|   └──core.py
+├──fedutils
+|   └──fedlog.py
+```
+extracted:
+sublibrary extracted contains code from the fed3 and fed3bandit library needed for the analysis workflows.
+
+fedassays:
+sublibrary contains code from Murrell that conducts the analysis of different assays to replicate the openly available colab journals.
+
+fedcore:
+sublibrary contains code from Murrell shared across all assay types used to read in processed data.
+
+fedutils:
+sublibrary contains utility functions to help deliver structured messages throughout the library.
+
+
+
+## AI Attribution
+Code was written with Assistance using generative AI. 
+ver: Claude Opus 4.8

fedverse-0.0.1/README.md

@@ -0,0 +1,43 @@
+# fedverse
+
+The purpose of fedverse is to create a unifying package of libraries that concern themselves with the analysis of FED devices in conjunction with the established workflow for the SSPsyGene project. Currently, fedverse inherits functions from fed3bandit written by Alex Legaria (https://fed3bandit.readthedocs.io/en/latest/analysis/fed3live_api.html) and the fed3 library written by Tom Earnest (https://earnestt1234.github.io/fed3/fed3/index.html). Additionally, this library includes code written for FED3Analyses by Chantelle Murrell (https://github.com/KravitzLab/FED3Analyses). 
+
+This library was created for the intention of of automating a analysis pipeline for the WUSMAC SSPsyGene analysis of FED devices. 
+
+The pipeline created by this library is meant to ingest L1 files alongside their key file and automate the process of creating an L4. Anything besides that functionality is outside the scope of the intended pipeline. 
+
+
+## Sub Library Architecture
+This library consists of sub libraries in this specific heiarchy:
+```
+├──extracted
+|   ├──fed3_fedframe.py
+|   ├──fed3_loading.py
+|   └──fed3bandit_extracted.py
+├──fedassays
+|   ├──fedbandit.py
+|   ├──fedpr1.py
+|   └──fedfr1.py
+├──fedassets
+├──fedcore
+|   └──core.py
+├──fedutils
+|   └──fedlog.py
+```
+extracted:
+sublibrary extracted contains code from the fed3 and fed3bandit library needed for the analysis workflows.
+
+fedassays:
+sublibrary contains code from Murrell that conducts the analysis of different assays to replicate the openly available colab journals.
+
+fedcore:
+sublibrary contains code from Murrell shared across all assay types used to read in processed data.
+
+fedutils:
+sublibrary contains utility functions to help deliver structured messages throughout the library.
+
+
+
+## AI Attribution
+Code was written with Assistance using generative AI. 
+ver: Claude Opus 4.8

fedverse-0.0.1/pyproject.toml

@@ -0,0 +1,6 @@
+# Build-system declaration only. All package metadata (name, version,
+# dependencies, package-data) lives in setup.py — a [project] table here
+# would take precedence and silently override it.
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"

fedverse-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fedverse-0.0.1/setup.py

@@ -0,0 +1,78 @@
+"""Packaging config for fedverse.
+
+Classic setuptools setup() — this file is the single source of truth for
+package metadata. pyproject.toml is kept for the build-system declaration
+only; if you move a metadata field back into a [project] table there, that
+table wins and the value here is silently ignored.
+
+Build and upload:
+    python -m pip install --upgrade build twine
+    python -m build                 # -> dist/fedverse-<ver>.tar.gz + .whl
+    python -m twine check dist/*
+    python -m twine upload dist/*
+"""
+
+from pathlib import Path
+
+from setuptools import find_packages, setup
+
+HERE = Path(__file__).parent
+LONG_DESCRIPTION = (HERE / "README.md").read_text(encoding="utf-8")
+
+# Runtime deps — every third-party package imported under src/fedverse.
+# pandas is pinned <3 because the extracted fed3/fed3bandit code relies on
+# pandas 2.x behaviour that the 3.0 release changes.
+INSTALL_REQUIRES = [
+    "pandas<3",
+    "numpy",
+    "matplotlib",
+    "scipy",
+    "seaborn",
+    "statsmodels",
+    "pingouin",
+    "tqdm",
+    "ipywidgets",
+    "ipython",       # IPython.display, used by the assay plotting helpers
+    "openpyxl",      # engine for pd.ExcelFile / read_excel on .xlsx L1 files
+]
+
+setup(
+    name="fedverse",
+    version="0.0.1",
+    description="FED3 multi-assay analysis pipeline (SSPsyGene)",
+    long_description=LONG_DESCRIPTION,
+    long_description_content_type="text/markdown",
+    author="William Rubio",
+    author_email="bernard.william@gmail.com",
+    url="https://github.com/willbrubio/fedverse",
+    project_urls={
+        "Source": "https://github.com/willbrubio/fedverse",
+        "Issues": "https://github.com/willbrubio/fedverse/issues",
+    },
+    license="MIT",
+    license_files=["LICENSE.md", "src/fedverse/extracted/LICENSE.*"],
+    # src-layout: importable packages live under src/, not at the repo root.
+    package_dir={"": "src"},
+    packages=find_packages(where="src"),
+    # Schematic images resolved at runtime by fedverse.fedassets.get().
+    package_data={"fedverse.fedassets": ["*.png", "*.svg", "*.jpg", "*.jpeg"]},
+    include_package_data=True,
+    zip_safe=False,  # fedassets.get() walks the package directory on disk
+    python_requires=">=3.10",
+    install_requires=INSTALL_REQUIRES,
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Science/Research",
+        # No "License ::" classifier on purpose: setuptools>=77 treats the
+        # license= value above as an SPDX expression and rejects packages that
+        # also carry a legacy license classifier.
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Topic :: Scientific/Engineering :: Bio-Informatics",
+    ],
+    keywords=["FED3", "neuroscience", "behavior", "operant", "SSPsyGene"],
+)

fedverse-0.0.1/src/fedverse/README.md

@@ -0,0 +1,36 @@
+# fedverse
+
+The purpose of fedverse is to create a unifying package of libraries that concern themselves with the analysis of FED devices in conjunction with the established workflow for the SSPsyGene project. Currently, fedverse inherits functions from fed3bandit written by Alex Legaria (https://fed3bandit.readthedocs.io/en/latest/analysis/fed3live_api.html) and the fed3 library written by Tom Earnest (https://earnestt1234.github.io/fed3/fed3/index.html). Additionally, this library includes code written for FED3Analyses by Chantelle Murrell (https://github.com/KravitzLab/FED3Analyses). 
+
+This library was created for the intention of being used in conjunction with the analysis pipeline for the WUSMAC SSPsyGene analysis pipeline of FED devices. 
+
+## Sub Library Architecture
+This library consists of sub libraries in this specific heiarchy:
+```
+├──extracted
+|   ├──fed3_fedframe.py
+|   ├──fed3_loading.py
+|   └──fed3bandit_extracted.py
+├──fedassays
+|   ├──fedbandit.py
+|   ├──fedpr1.py
+|   └──fedfr1.py
+├──fedcore
+|   └──core.py
+├──fedutils
+|   └──fedlog.py
+```
+extracted:
+sublibrary extracted contains code from the fed3 and fed3bandit library needed for the analysis workflows.
+
+fedassays:
+sublibrary contains code from Murrell that conducts the analysis of different assays to replicate the openly available colab journals.
+
+fedcore:
+sublibrary contains code from Murrell shared across all assay types used to read in processed data.
+
+fedutils:
+sublibrary contains utility functions to help deliver structured messages throughout the library.
+
+
+

fedverse-0.0.1/src/fedverse/extracted/LICENSE.fed3

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.