AnomalousLib

AnomalousLib is a Python library designed for the study of anomalous diffusion.

It supports dataset generation, statistical analysis, model inference, and integrated result visualization.

The library is published on PyPI under the name AnomalousLib and uses Python version 3.12.10 or later.

Repository Structure

The following diagram shows the structure of the repository:

AnomalousLib
│   # Package builds
├───dist
│   # Source code
├───src
│   └───anomalouslib
│       │   # Analytical tools and metrics
│       ├───analysis
│       │   # Dataset handling and generation
│       ├───data
│       │   # Model definitions and inference
│       ├───models
│       │   # Output handling and reporting
│       ├───results
│       │   # Utility functions and helpers
│       └───utils
│   # QA and testing
└───tests

Development Setup

To test the library locally, follow these steps. All commands should be run from the root of the project, where the pyproject.toml file is located.

1. Set Up the Virtual Environment

First, create a virtual environment:

python -m venv venv

Then activate it:

• On Linux/macOS:

  source venv/bin/activate
  

• On Windows:

  .\venv\Scripts\Activate.ps1
  

💡 Note: To deactivate the environment at any time (on both Linux and Windows), use:

deactivate

2. Install Dependencies

Install the required libraries listed in requirements.txt:

pip install -r requirements.txt

To verify the installation, you can regenerate the requirements.txt and check for any differences:

• On Linux/macOS:

  pip freeze | grep -vE "^-e |@ file://" > requirements.txt
  

• On Windows:

  pip freeze | Select-String -NotMatch '^-e |@ file://' > requirements.txt
  

💡 Note: This filtering step avoids including the local installation of the library itself.

If no changes appear in the file, the setup is correct.

Local Build & Installation

1. Build the Library

Generate the distribution packages:

python -m build

2. Install the Library Locally

• First-time installation (or to force reinstall):

  pip install ./dist/anomalouslib-{lib_version}-py3-none-any.whl --force-reinstall
  

• Subsequent updates (faster and applies only changes):

  pip install --upgrade ./dist/anomalouslib-{lib_version}-py3-none-any.whl
  

💡 Note: Replace {lib_version} with the actual library version, e.g.: pip install --upgrade ./dist/anomalouslib-0.1.0-py3-none-any.whl

Publishing to PyPI

To publish the package to PyPI, run:

twine upload ./dist/*

⚠️ Important: Make sure no version in the ./dist/ folder has already been uploaded to PyPI.

As stated on the PyPI page, to install AnomalousLib on other environments:

pip install anomalouslib

💡 It is strongly recommended not to install the public PyPI version in the same local environment to avoid confusion with the local development version.