| Name | bifurc2midi JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | This application generates midi bifurcation diagrams generated from generated logistic map data. |
| upload_time | 2023-05-30 22:13:50 |
| maintainer | |
| docs_url | None |
| author | Josh |
| requires_python | |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# bifurc2midi
This application generates midi bifurcation diagrams generated from generated logistic map data.
See [instructions for installation on macOS](docs/MACOS.md) for more detailed guide on getting started.
## Installation
- Prerequisites:
- Python 3
- pip
Make sure pip is up to date:
```bash
python3 -m pip install --upgrade pip
```
- Install package from source code:
```bash
pip install .
```
- Now you can run the application from the command line e.g.
```bash
bifurc2midi --version
```
## Usage
- For help:
```bash
bifurc2midi --help
```
- Run with default settings:
```bash
bifurc2midi
```
This will generate a midi file in the current working directory.
- Sending midi output to a specific device:
```
bifurc2midi --midi-out-device device_name
```
Where `device_name` is the name of the midi device you want to send the output to. Use a `device name` of 'default' to use the first available device e.g.
```bash
bifurc2midi --midi-out-device 'device_name'
```
- Enabling midi loopback driver on macOS (e.g. for use with DAWS):
1. Open 'Audio MIDI Setup.app'
2. Click 'Window' -> 'Show MIDI Studio'
3. Double click 'IAC Driver' device
4. Check 'Device is online' checkbox
5. Click 'Apply'
6. Make sure 'IAC Driver' enabled as a midi input device in your DAW
## Development
- Pre-requisites:
- Python 3
- pip
- virtualenv
- Use the Makefile for local development:
1. Activate a virtual environment:
```bash
make virtualenv
```
2. Activate the virtual environment (not strictly necessary, if using the Makefile only):
```bash
source venv/bin/activate
```
3. Install dependencies:
```bash
make install
```
Then you can:
- Run the application:
```bash
make run
```
Extra arguments can be passed by providing EXTRA_ARGS variable e.g.
```bash
make run EXTRA_ARGS="--help"
```
- Run tests:
```bash
make test
```
- Run linter:
```bash
make lint
```
`make fmt` can be used to automatically fix some linting errors.
- Other useful make targets are provided too, see the Makefile for details. Or run `make`/`make help`
## TODO
- Investigate improving blending of note transitions/overlaps
- Add tests, replace the placeholder test
- Run tests in github actions
- Release as a package
- Review what is settings/parameters are configurable
- Installation shell script
- Add support to specify the starting note
- GUI
- Realtime parameter tweaking as it sends midi to output
Raw data
{
"_id": null,
"home_page": "",
"name": "bifurc2midi",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Josh",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/86/ae/2e68409e5ef49d559df6099129fa89720a2cc80bc37b627b40ab5f95468f/bifurc2midi-0.0.1.tar.gz",
"platform": null,
"description": "# bifurc2midi\n\nThis application generates midi bifurcation diagrams generated from generated logistic map data.\n\nSee [instructions for installation on macOS](docs/MACOS.md) for more detailed guide on getting started.\n\n## Installation\n\n- Prerequisites:\n - Python 3\n - pip\n\nMake sure pip is up to date:\n```bash\npython3 -m pip install --upgrade pip\n```\n\n- Install package from source code:\n```bash\npip install .\n```\n\n- Now you can run the application from the command line e.g.\n```bash\nbifurc2midi --version\n```\n## Usage\n\n- For help:\n```bash\nbifurc2midi --help\n```\n\n- Run with default settings:\n```bash\nbifurc2midi\n```\nThis will generate a midi file in the current working directory.\n\n- Sending midi output to a specific device:\n\n```\nbifurc2midi --midi-out-device device_name\n```\n\nWhere `device_name` is the name of the midi device you want to send the output to. Use a `device name` of 'default' to use the first available device e.g.\n\n```bash\nbifurc2midi --midi-out-device 'device_name'\n```\n\n- Enabling midi loopback driver on macOS (e.g. for use with DAWS):\n 1. Open 'Audio MIDI Setup.app'\n 2. Click 'Window' -> 'Show MIDI Studio'\n 3. Double click 'IAC Driver' device\n 4. Check 'Device is online' checkbox\n 5. Click 'Apply'\n 6. Make sure 'IAC Driver' enabled as a midi input device in your DAW\n\n## Development\n\n- Pre-requisites:\n - Python 3\n - pip\n - virtualenv\n\n- Use the Makefile for local development:\n\n1. Activate a virtual environment:\n```bash\nmake virtualenv\n```\n\n2. Activate the virtual environment (not strictly necessary, if using the Makefile only):\n```bash\nsource venv/bin/activate\n```\n\n3. Install dependencies:\n```bash\nmake install\n```\n\nThen you can:\n\n- Run the application:\n```bash\nmake run\n```\nExtra arguments can be passed by providing EXTRA_ARGS variable e.g.\n```bash\nmake run EXTRA_ARGS=\"--help\"\n```\n\n- Run tests:\n```bash\nmake test\n```\n\n- Run linter:\n```bash\nmake lint\n```\n`make fmt` can be used to automatically fix some linting errors.\n\n- Other useful make targets are provided too, see the Makefile for details. Or run `make`/`make help`\n\n## TODO\n\n- Investigate improving blending of note transitions/overlaps\n- Add tests, replace the placeholder test\n- Run tests in github actions\n- Release as a package\n- Review what is settings/parameters are configurable\n- Installation shell script\n- Add support to specify the starting note\n- GUI\n- Realtime parameter tweaking as it sends midi to output\n",
"bugtrack_url": null,
"license": "",
"summary": "This application generates midi bifurcation diagrams generated from generated logistic map data.",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97a44e48027cba085d99346c8fb9f5b311d433277dcaac2cdac81410e78fe754",
"md5": "c3139da87bde8ad31c476aefc78a1b3a",
"sha256": "2ccf8cbbb87e53d8d85c46cc12af347ae8fa9796a4eca5c776c707463d161754"
},
"downloads": -1,
"filename": "bifurc2midi-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3139da87bde8ad31c476aefc78a1b3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9454,
"upload_time": "2023-05-30T22:13:48",
"upload_time_iso_8601": "2023-05-30T22:13:48.513947Z",
"url": "https://files.pythonhosted.org/packages/97/a4/4e48027cba085d99346c8fb9f5b311d433277dcaac2cdac81410e78fe754/bifurc2midi-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86ae2e68409e5ef49d559df6099129fa89720a2cc80bc37b627b40ab5f95468f",
"md5": "e906ee06967be005c02136ea8c5d8526",
"sha256": "baab410a55ce312e830443c4fc231c9dbef71a7567474647e229186f94d07663"
},
"downloads": -1,
"filename": "bifurc2midi-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e906ee06967be005c02136ea8c5d8526",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9003,
"upload_time": "2023-05-30T22:13:50",
"upload_time_iso_8601": "2023-05-30T22:13:50.423704Z",
"url": "https://files.pythonhosted.org/packages/86/ae/2e68409e5ef49d559df6099129fa89720a2cc80bc37b627b40ab5f95468f/bifurc2midi-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-30 22:13:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bifurc2midi"
}
