miz-dac


Namemiz-dac JSON
Version 0.3.2 PyPI version JSON
download
home_pageNone
SummaryMinimal measurement data analysis frame with nodes and container.
upload_time2024-06-15 20:44:00
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseApache-2.0
keywords data context analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Data Action Context

DAC provides a minimal frame for (measurement) data analysis
if you want to:

- Visualize data, process and interact
- Customize your analysis
- Save the analysis and load back
- Enable multiple analysis of same processing (like batch analysis)
- Link different analysis

Example of DAC user interface as shown below:

![DAC GUI](./doc/dac-gui.png)

## Concepts

### Data & Action

The processing is essentially "function call to data (objects or parameters)".

The actions to data can be processing (non-interactive and time consuming, with outputs) or visualing (interactive, no output).

### Interaction

Predefined click-able Jupyter notebook

### Context

For multiple measurements / analyses under different conditions, the processing can be very similar, with a few parameters changed.

To enable same processing and share "variable names" among different conditions, context is used.

### Auxiliaries

**Quick tasks (on action node)**

For parameter input, sometimes we need to interact with output of previous action and set,
or we're inputting something long (e.g. a file path).

"Quick tasks" helps to fill the parameters with interactions.

**Quick actions (on data node)**

To explore data, actions can be created and accept the data as input.
However, it costs several steps, and sometimes we want just exploring freely.

"Quick actions" creates actions virtually (not adding to project) who function to selected data nodes with default parameters.
If delicate parameter tuning is required, then create a normal action.

## Get started

## Modules

Besides the minimal frame, this repo also provides usable modules for common measurement data analyis.

## Extending

### `data.py` and `actions.py`

For each module (contains a bunch of analysis methods of same topic),
data types and the processing/visualization methods need defined.

(scripting: use the classes directly)

### `plugins.yaml`

A YAML file is used to control which actions are available at what context, it helps:
1. Separate different analysis, keep related actions
2. Use the order to guide analyzing sequence
3. Easily adapt or reuse actions

## Appendix

### OOP or function calls

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "miz-dac",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "data, context, analysis",
    "author": null,
    "author_email": "MIZiper <miziper@163.com>",
    "download_url": "https://files.pythonhosted.org/packages/92/74/7b42d9691d84dec56e10ac0782c232ed75f639f6f3422179c892392f78c1/miz_dac-0.3.2.tar.gz",
    "platform": null,
    "description": "# Data Action Context\n\nDAC provides a minimal frame for (measurement) data analysis\nif you want to:\n\n- Visualize data, process and interact\n- Customize your analysis\n- Save the analysis and load back\n- Enable multiple analysis of same processing (like batch analysis)\n- Link different analysis\n\nExample of DAC user interface as shown below:\n\n![DAC GUI](./doc/dac-gui.png)\n\n## Concepts\n\n### Data & Action\n\nThe processing is essentially \"function call to data (objects or parameters)\".\n\nThe actions to data can be processing (non-interactive and time consuming, with outputs) or visualing (interactive, no output).\n\n### Interaction\n\nPredefined click-able Jupyter notebook\n\n### Context\n\nFor multiple measurements / analyses under different conditions, the processing can be very similar, with a few parameters changed.\n\nTo enable same processing and share \"variable names\" among different conditions, context is used.\n\n### Auxiliaries\n\n**Quick tasks (on action node)**\n\nFor parameter input, sometimes we need to interact with output of previous action and set,\nor we're inputting something long (e.g. a file path).\n\n\"Quick tasks\" helps to fill the parameters with interactions.\n\n**Quick actions (on data node)**\n\nTo explore data, actions can be created and accept the data as input.\nHowever, it costs several steps, and sometimes we want just exploring freely.\n\n\"Quick actions\" creates actions virtually (not adding to project) who function to selected data nodes with default parameters.\nIf delicate parameter tuning is required, then create a normal action.\n\n## Get started\n\n## Modules\n\nBesides the minimal frame, this repo also provides usable modules for common measurement data analyis.\n\n## Extending\n\n### `data.py` and `actions.py`\n\nFor each module (contains a bunch of analysis methods of same topic),\ndata types and the processing/visualization methods need defined.\n\n(scripting: use the classes directly)\n\n### `plugins.yaml`\n\nA YAML file is used to control which actions are available at what context, it helps:\n1. Separate different analysis, keep related actions\n2. Use the order to guide analyzing sequence\n3. Easily adapt or reuse actions\n\n## Appendix\n\n### OOP or function calls\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Minimal measurement data analysis frame with nodes and container.",
    "version": "0.3.2",
    "project_urls": {
        "Homepage": "http://mizip.net/",
        "Repository": "https://github.com/MIZiper/dac.git"
    },
    "split_keywords": [
        "data",
        " context",
        " analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b2a2627e1b6aff19c20fffc2854cf4f7782979ee53c67cf72c1b62ca662686b",
                "md5": "f04b05ac6143a2fc9fffc4b8ba7853a2",
                "sha256": "a95619547c74e2fffee5f326f3b33c4f1ae2eb1f0bc17154f8a61e791e1359c7"
            },
            "downloads": -1,
            "filename": "miz_dac-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f04b05ac6143a2fc9fffc4b8ba7853a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 38016,
            "upload_time": "2024-06-15T20:43:59",
            "upload_time_iso_8601": "2024-06-15T20:43:59.058925Z",
            "url": "https://files.pythonhosted.org/packages/0b/2a/2627e1b6aff19c20fffc2854cf4f7782979ee53c67cf72c1b62ca662686b/miz_dac-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "92747b42d9691d84dec56e10ac0782c232ed75f639f6f3422179c892392f78c1",
                "md5": "c033e5b4aee90bb78ecf7f9a7a470c23",
                "sha256": "eeb010beb59b8387dd11ccf7bc0d87d1955b65b7f4e4217a019b99bf3ad4a1b0"
            },
            "downloads": -1,
            "filename": "miz_dac-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "c033e5b4aee90bb78ecf7f9a7a470c23",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 32652,
            "upload_time": "2024-06-15T20:44:00",
            "upload_time_iso_8601": "2024-06-15T20:44:00.096694Z",
            "url": "https://files.pythonhosted.org/packages/92/74/7b42d9691d84dec56e10ac0782c232ed75f639f6f3422179c892392f78c1/miz_dac-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-15 20:44:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MIZiper",
    "github_project": "dac",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "miz-dac"
}
        
Elapsed time: 0.32419s