well-plate


Namewell-plate JSON
Version 0.0.4 PyPI version JSON
download
home_pagehttps://github.com/dylanwal/well_plate
SummaryWork with well plates!
upload_time2023-09-11 13:02:47
maintainer
docs_urlNone
authorDylan Walsh
requires_python>=3.9
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Well Plate (well_plate)

---
---
![PyPI](https://img.shields.io/pypi/v/well_plate)
![downloads](https://static.pepy.tech/badge/well_plate)
![license](https://img.shields.io/github/license/dylanwal/well_plate)

Makes nice visualizations of well plates!


---

## Installation

```
pip install well_plate
```

## Dependencies

[numpy](https://github.com/numpy/numpy)

[pandas](https://github.com/pandas-dev/pandas)

[plotly](https://github.com/plotly/plotly.py)

---
---

## Options

* Well numbers
  * 6
  * 12
  * 24
  * 96
  * 384
  * To add more see [well_plate/config.py](https://github.com/dylanwal/well_plate/blob/master/well_plate/config.py)

* Well shape
  * 'circle'
  * 'rect' (square)

* Add data
  * use `wp.add_data()`; pass in a pd.Series with the index corresponding to well plate index (eg. "A1", "E4", ...)

---
---

## Example
### Basic example
```python
    import well_plate

    wp = well_plate.WellPlate(24)
    wp.plot()
```
![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/well_plate_24.svg)

### Change well size
```python
    import well_plate

    wp = well_plate.WellPlate(96, "rect")
    wp.plot()
```
![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/well_plate_96r.svg)

# Add data

```python
    import pandas as pd    
    import well_plate

    wp = well_plate.WellPlate(384, "rect")
    
    df = pd.read_csv("example1_data.csv", index_col=0)
    wp.add_data(df["mw_n"])
    
    wp.plot(key="mw_n")
    wp.heatmap(key="mw_n")
```
![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/well_plate_with_data.svg)
![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/heatmap.svg)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dylanwal/well_plate",
    "name": "well-plate",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "",
    "author": "Dylan Walsh",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c0/7c/2e00c27cf071e6f00cdfcb0f5190846f0c615d72c4a18e5426df6d9b80f8/well_plate-0.0.4.tar.gz",
    "platform": "any",
    "description": "# Well Plate (well_plate)\r\n\r\n---\r\n---\r\n![PyPI](https://img.shields.io/pypi/v/well_plate)\r\n![downloads](https://static.pepy.tech/badge/well_plate)\r\n![license](https://img.shields.io/github/license/dylanwal/well_plate)\r\n\r\nMakes nice visualizations of well plates!\r\n\r\n\r\n---\r\n\r\n## Installation\r\n\r\n```\r\npip install well_plate\r\n```\r\n\r\n## Dependencies\r\n\r\n[numpy](https://github.com/numpy/numpy)\r\n\r\n[pandas](https://github.com/pandas-dev/pandas)\r\n\r\n[plotly](https://github.com/plotly/plotly.py)\r\n\r\n---\r\n---\r\n\r\n## Options\r\n\r\n* Well numbers\r\n  * 6\r\n  * 12\r\n  * 24\r\n  * 96\r\n  * 384\r\n  * To add more see [well_plate/config.py](https://github.com/dylanwal/well_plate/blob/master/well_plate/config.py)\r\n\r\n* Well shape\r\n  * 'circle'\r\n  * 'rect' (square)\r\n\r\n* Add data\r\n  * use `wp.add_data()`; pass in a pd.Series with the index corresponding to well plate index (eg. \"A1\", \"E4\", ...)\r\n\r\n---\r\n---\r\n\r\n## Example\r\n### Basic example\r\n```python\r\n    import well_plate\r\n\r\n    wp = well_plate.WellPlate(24)\r\n    wp.plot()\r\n```\r\n![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/well_plate_24.svg)\r\n\r\n### Change well size\r\n```python\r\n    import well_plate\r\n\r\n    wp = well_plate.WellPlate(96, \"rect\")\r\n    wp.plot()\r\n```\r\n![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/well_plate_96r.svg)\r\n\r\n# Add data\r\n\r\n```python\r\n    import pandas as pd    \r\n    import well_plate\r\n\r\n    wp = well_plate.WellPlate(384, \"rect\")\r\n    \r\n    df = pd.read_csv(\"example1_data.csv\", index_col=0)\r\n    wp.add_data(df[\"mw_n\"])\r\n    \r\n    wp.plot(key=\"mw_n\")\r\n    wp.heatmap(key=\"mw_n\")\r\n```\r\n![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/well_plate_with_data.svg)\r\n![well_plate](https://raw.githubusercontent.com/dylanwal/well_plate/master/examples/heatmap.svg)\r\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Work with well plates!",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/dylanwal/well_plate"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9f29613e36ce5fd52eb996ee2c884217f4def28a9f8cce1f537562c8bec023c2",
                "md5": "f9c8df8191bbd7d13969252be54c980d",
                "sha256": "8d4bf4c58c086729c7d3a2aa4a2bc967e548fbf8cbf422c0d49dc7ebff56db9a"
            },
            "downloads": -1,
            "filename": "well_plate-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f9c8df8191bbd7d13969252be54c980d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 8796,
            "upload_time": "2023-09-11T13:02:46",
            "upload_time_iso_8601": "2023-09-11T13:02:46.762953Z",
            "url": "https://files.pythonhosted.org/packages/9f/29/613e36ce5fd52eb996ee2c884217f4def28a9f8cce1f537562c8bec023c2/well_plate-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c07c2e00c27cf071e6f00cdfcb0f5190846f0c615d72c4a18e5426df6d9b80f8",
                "md5": "4e83ac2e3b3618fa89733c6e163d2850",
                "sha256": "7c03bb752e78f5fc3984358d5acd038af89ffc5d546799d83b85ce637b00f10b"
            },
            "downloads": -1,
            "filename": "well_plate-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "4e83ac2e3b3618fa89733c6e163d2850",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 8605,
            "upload_time": "2023-09-11T13:02:47",
            "upload_time_iso_8601": "2023-09-11T13:02:47.790146Z",
            "url": "https://files.pythonhosted.org/packages/c0/7c/2e00c27cf071e6f00cdfcb0f5190846f0c615d72c4a18e5426df6d9b80f8/well_plate-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-11 13:02:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dylanwal",
    "github_project": "well_plate",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "well-plate"
}
Dylan Walsh
Elapsed time: 0.27203s