ODBPlotter


NameODBPlotter JSON
Version 0.0.3 PyPI version JSON
download
home_page
SummaryTODO
upload_time2023-01-31 22:58:12
maintainer
docs_urlNone
author
requires_python
license
keywords todo
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ODB Plotter

## Install with pip
```shell
pip install ODBPlotter
```

## ODB Plotter Design Goals

### I intend for this project to serve two purposes:
- First, implement an extensible, flexible api for accessing data within .odb files or .hdf5 files with odb data
- Second, implement a user-friendly, sane-defaults cli to allow for quick data extraction, manipulation, and visualization with no hassle

### What things need to be parametrized in the CLI?
- Target File (.odb or .hdf5) --> Not Stored in userOptions
- Physical dimensions (x min & max, y min & max, z min & max) --> Not stored in UserOptions
- Temporal dimensions (start time & stop time) --> Not Stored in userOptions
- Mesh Seed Size (Stored with the .hdf5 in a .json) --> Not Stored in userOptions
- Meltpoint (Stored with jthe .hdf5 in a .json) --> Not Stored in userOptions
- Time Sample Size (N for extracting from every Nth frame) (Stored with the .hdf5 in a .json) --> Not Stored in userOptions
- Location of input files (default .hdf5 directory)
- Location of any output file (default output directory)
- View Angle (By default values or Elevation/Azimuth/Roll) --> Not Stored in userOptions
- Toggle use of the interactive viewer
- Run Immediately (Set the program to run if all necessary flags are set)

### Current TODOS (Waiting for the official github repo to open issues...)
- Migrate to .json5 (comments in views.json5 file)
- Create OdbVisualizer Class to implement views and plotting functionality separately
- Manage Views in a more sane way
- Update CLI to take in user input from source config file
    - Use platformdirs
- Generate default config with platformdirs on install
- Test/rework lighting on all sides
- Parametrize all relevant values in the odb_to_npz.py script
- Add 2D plotting methods
- Add support for melt pool plot
- Add support for non-temperature based plots
- Interpolate Colors
- Consider moving to mayavi

### TEMP:
```
angle: "Top-Right-Fromt Vertex: top" (May pass in a relevant string from views.json5 or a 3-tuple of Elevation/Azimuth/Roll)

    # TODO Default
    parser.add_argument("-v", "--view")
    
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ODBPlotter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "Clark Hensley <clarkhensley@duck.com>",
    "keywords": "TODO",
    "author": "",
    "author_email": "Clark Hensley <clarkhensley@duck.com>",
    "download_url": "https://files.pythonhosted.org/packages/34/ee/6842aaf9c179386b3c73df6247d9022d38b3b4b704e259e1f4b9f9cd24f6/ODBPlotter-0.0.3.tar.gz",
    "platform": null,
    "description": "# ODB Plotter\n\n## Install with pip\n```shell\npip install ODBPlotter\n```\n\n## ODB Plotter Design Goals\n\n### I intend for this project to serve two purposes:\n- First, implement an extensible, flexible api for accessing data within .odb files or .hdf5 files with odb data\n- Second, implement a user-friendly, sane-defaults cli to allow for quick data extraction, manipulation, and visualization with no hassle\n\n### What things need to be parametrized in the CLI?\n- Target File (.odb or .hdf5) --> Not Stored in userOptions\n- Physical dimensions (x min & max, y min & max, z min & max) --> Not stored in UserOptions\n- Temporal dimensions (start time & stop time) --> Not Stored in userOptions\n- Mesh Seed Size (Stored with the .hdf5 in a .json) --> Not Stored in userOptions\n- Meltpoint (Stored with jthe .hdf5 in a .json) --> Not Stored in userOptions\n- Time Sample Size (N for extracting from every Nth frame) (Stored with the .hdf5 in a .json) --> Not Stored in userOptions\n- Location of input files (default .hdf5 directory)\n- Location of any output file (default output directory)\n- View Angle (By default values or Elevation/Azimuth/Roll) --> Not Stored in userOptions\n- Toggle use of the interactive viewer\n- Run Immediately (Set the program to run if all necessary flags are set)\n\n### Current TODOS (Waiting for the official github repo to open issues...)\n- Migrate to .json5 (comments in views.json5 file)\n- Create OdbVisualizer Class to implement views and plotting functionality separately\n- Manage Views in a more sane way\n- Update CLI to take in user input from source config file\n    - Use platformdirs\n- Generate default config with platformdirs on install\n- Test/rework lighting on all sides\n- Parametrize all relevant values in the odb_to_npz.py script\n- Add 2D plotting methods\n- Add support for melt pool plot\n- Add support for non-temperature based plots\n- Interpolate Colors\n- Consider moving to mayavi\n\n### TEMP:\n```\nangle: \"Top-Right-Fromt Vertex: top\" (May pass in a relevant string from views.json5 or a 3-tuple of Elevation/Azimuth/Roll)\n\n    # TODO Default\n    parser.add_argument(\"-v\", \"--view\")\n    \n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "TODO",
    "version": "0.0.3",
    "split_keywords": [
        "todo"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c530c5c705d93a8967e9ae669126c3b4fe32147c164c96195652a7874c5e0d1e",
                "md5": "d8f57cf79ff8eec81f72b08ea472616a",
                "sha256": "a52d9570ad81e6714007e50bb653026c917fcb7761dee938697210dc9ddd3ed8"
            },
            "downloads": -1,
            "filename": "ODBPlotter-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d8f57cf79ff8eec81f72b08ea472616a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 21020,
            "upload_time": "2023-01-31T22:58:10",
            "upload_time_iso_8601": "2023-01-31T22:58:10.730255Z",
            "url": "https://files.pythonhosted.org/packages/c5/30/c5c705d93a8967e9ae669126c3b4fe32147c164c96195652a7874c5e0d1e/ODBPlotter-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "34ee6842aaf9c179386b3c73df6247d9022d38b3b4b704e259e1f4b9f9cd24f6",
                "md5": "2d259ea75cd2d45daaea9532aa5e1cd9",
                "sha256": "0cb193bae3d8d431bca9e1b95a7acc5f865c1394a3b47ed6d359683ce76f0a7b"
            },
            "downloads": -1,
            "filename": "ODBPlotter-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2d259ea75cd2d45daaea9532aa5e1cd9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 18255,
            "upload_time": "2023-01-31T22:58:12",
            "upload_time_iso_8601": "2023-01-31T22:58:12.915132Z",
            "url": "https://files.pythonhosted.org/packages/34/ee/6842aaf9c179386b3c73df6247d9022d38b3b4b704e259e1f4b9f9cd24f6/ODBPlotter-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-31 22:58:12",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "odbplotter"
}
        
Elapsed time: 0.18498s