{ "info": { "author": "Joshua Van Deren", "author_email": "jvanderen1@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering :: Human Machine Interfaces", "Topic :: Software Development :: User Interfaces" ], "description": "# Kodimer_Project (or WAV2BIN)\n\n\"WAV2BIN\"\n\nProgram to be used concurrently with Dennis Kodimer's CEC 222 lab. Features include:\n\n* Drawing / Creating Waveforms\n* Manipulating Waveforms\n* Storing Multiple Waveforms\n* Exporting Waveforms\n\n## Getting Started\n\nThese instructions will help get you a copy of the project up and running on your local machine.\n\n### Prerequisites\n\nThis program runs on `Python 3.x` with the following required packages (also in `requirements.txt`:\n\n```\nmatplotlib\nnumpy\nscipy \n```\n**For Mac Users**: Included is a `Makefile`, which can be used to download the dependencies by simply executing `make init`\n\n### Installing\n\nTo run this, simply use:\n\n#### Windows `py -3 wav2bin\\src`\n#### Mac `python3 wav2bin\\src` \n\n**For Mac Users**: Included is a `Makefile`, which can be used to run the program by simply executing `make run`\n\n## Usage\nHere are some helpful tips and pointers on how to use the software.\n\n### Drawing / Creating Waveforms\nWhen the program is first run, a window should appear like this:\n\n![Starting Screen](https://user-images.githubusercontent.com/22926257/36080118-9f369f12-0f48-11e8-98ad-2049f3d4775b.png)\n\nThere are two ways to generate a waveform:\n\n* Drawing\n* Creating\n\n#### Drawing Waveforms\nSimply move the mouse from left-to-right on the plot to begin drawing a waveform.\n\n**Example:**\n\n![Currently Drawing Waveform](https://user-images.githubusercontent.com/22926257/36080162-1cb9955c-0f49-11e8-9aa5-4f3a41a5df9b.png)\n\nWhen the right-edge is reached, a complete waveform should be visible.\n\n![Finished Drawing Waveform](https://user-images.githubusercontent.com/22926257/36080199-ad47d1ec-0f49-11e8-9a2d-03f67ed8404f.png)\n\n**Note:** Drawing is disabled when a waveform has been drawn or created. To re-enable this, simply `Clear` the waveform.\n\n#### Creating Waveforms\nUsing the premade options at the bottom (located under `Utilize Other Graphs`) . . .\n\n![screen shot 3](https://user-images.githubusercontent.com/22926257/36080220-f3f29258-0f49-11e8-962e-c61458bcf796.png)\n\nIt is possible to create different pre-made waveforms. All that is required is:\n\n1. Enter value for `Cycles` (*Positive Float*)\n2. Select either `Mix Function` or `Overwrite Function`\n\n`Mix Function` is additive (will add waveform on top of currently made waveform). \n`Overwrite Function` is replacement (will overwrite waveform in place of currently made waveform).\n\n**Example:** *Sine: 3 Cycles with Overwrite Function*\n\n![Sine: 3 Cycles with Overwrite Function](https://user-images.githubusercontent.com/22926257/36080270-cfac879a-0f4a-11e8-964e-baf9675182ba.png)\n\n**Example:** *Random: 2.5 Cycles with Mix Function*\n\n![Random: 2.5 Cycles with Mix Function](https://user-images.githubusercontent.com/22926257/36080282-0650a7f4-0f4b-11e8-9f84-ec5c5dd880d6.png)\n\n### Manipulating Waveforms\nThe basic properties of a waveform can be manipulated as well. These can be found under `Basic Graph Properties`:\n\n* Frequency (*Positive Integer*)\n* Amplitude (*Float*)\n* Level (*Float*)\n\nSimply enter a value and hit the return key.\n\n**Example:** *Level: -105*\n\n![Level: -105](https://user-images.githubusercontent.com/22926257/36080359-39f43b7e-0f4c-11e8-8fe8-2c8a29248e6a.png)\n\n**Example:** *Frequency: 3*\n\n![Frequency: 3](https://user-images.githubusercontent.com/22926257/36080367-58e06f4e-0f4c-11e8-8908-e401794af41f.png)\n\nIn both cases, the `Clear` option should reset the waveforms to nothing.\n\n### Storing Multiple Waveforms\nMany waveforms can be stored and manipulated in this program (up to 32 total). Each is unique and separate from one another:\n\n![Multiple Waveforms](https://user-images.githubusercontent.com/22926257/36080388-a1db50d8-0f4c-11e8-803f-14c01fdd309b.png)\n\nWhen *Creating Waveforms*, another waveform can be referenced for usage.\n\n**Example:**\n\nLet's say that this waveform is drawn under `Waveform 1`:\n\n![Waveform 1](https://user-images.githubusercontent.com/22926257/36080416-02cd22c2-0f4d-11e8-9866-7de3ebb5ed6b.png)\n\nGoing to `Utilize Other Graphs` \u2192 `Functions`, by selecting `Waveform`, another option box appears with values 0 - 31; these are the other waveforms that can be accessed.\n\nMake sure that `Waveform 0` is selected and enter `2 Cycles`. Select `Mix Function` and the result should be as follows:\n\n![Mix Another Waveform](https://user-images.githubusercontent.com/22926257/36080476-fef6df20-0f4d-11e8-9cb2-9a5caaa30234.png)\n\n### Exporting Graphs\nOnce satisfied with the waveforms, they can all be exported to a `.bin` file. Simply select `Export` at the bottom. (There's an option to print to `.pdf` following selecting `Export`).\n\nWhen exporting, there should be a screen of all the binary being sent to the file in hexadecimal form:\n\n![Binary Waveforms](https://user-images.githubusercontent.com/22926257/36080508-7848e3e6-0f4e-11e8-8353-bfca71e7147f.png)\n\nFollowed by the produced `.bin` file.\n\nIf a `.pdf` was generated, it should look something like this:\n\n![Pdf Waveforms](https://user-images.githubusercontent.com/22926257/36080557-0445dce6-0f4f-11e8-8455-339d21ef0002.png)\n\n## Authors\n\n* **Joshua Van Deren** - *Initial work* - [jvanderen1](https://github.com/jvanderen1)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jvanderen1/Kodimer_Project", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "wav2bin", "package_url": "https://pypi.org/project/wav2bin/", "platform": "", "project_url": "https://pypi.org/project/wav2bin/", "project_urls": { "Homepage": "https://github.com/jvanderen1/Kodimer_Project" }, "release_url": "https://pypi.org/project/wav2bin/1.3/", "requires_dist": null, "requires_python": ">=3", "summary": "Program to be used concurrently with Dennis Kodimer's CEC 222 lab.", "version": "1.3" }, "last_serial": 3577220, "releases": { "1.3": [ { "comment_text": "", "digests": { "md5": "777fee325e8d27c8907cfe6632287a49", "sha256": "b6186fce87c3cdb7932c64071d1d866c560f8b9998952b38a189d8c5712cd096" }, "downloads": -1, "filename": "wav2bin-1.3.tar.gz", "has_sig": false, "md5_digest": "777fee325e8d27c8907cfe6632287a49", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 65678, "upload_time": "2018-02-13T06:29:38", "url": "https://files.pythonhosted.org/packages/23/2d/e416d5efede05e43c7ec80890c30debf63f9ca44eb6e66dd1ac693d5af00/wav2bin-1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "777fee325e8d27c8907cfe6632287a49", "sha256": "b6186fce87c3cdb7932c64071d1d866c560f8b9998952b38a189d8c5712cd096" }, "downloads": -1, "filename": "wav2bin-1.3.tar.gz", "has_sig": false, "md5_digest": "777fee325e8d27c8907cfe6632287a49", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 65678, "upload_time": "2018-02-13T06:29:38", "url": "https://files.pythonhosted.org/packages/23/2d/e416d5efede05e43c7ec80890c30debf63f9ca44eb6e66dd1ac693d5af00/wav2bin-1.3.tar.gz" } ] }