# Musketeer
A software tool for fitting data from titration experiments.
## Installation
### Windows & MacOS:
You can install the latest .msi or .dmg installer [here](https://github.com/daniilS/Musketeer/releases/latest).
### Any platform (requires Python)
Install the latest release of python from [the official website](https://www.python.org/downloads/). Then, in a terminal window or command prompt, type:
- Mac: `python3 -m pip install musketeer`
- Windows: `python -m pip install musketeer`
You can now run Musketeer any time by typing:
- Mac: `python3 -m musketeer`
- Windows: `python -m musketeer`
## Usage Instructions
### Example files
Two example files are provided:
- [A UV-Vis titration with guest absorption](examples/UV-Vis_example.fit?raw=1), from https://doi.org/10.1039/D2SC04271A
- [A 31-P NMR denaturation experiment](examples/NMR_example.fit?raw=1), from https://doi.org/10.1039/D1SC02288A
### Loading titration data
When starting Musketeer, you will see the option to either **Create a new fit file** or **Open an existing file**. Musketeer can directly open the following files:
- `.fit` files created using Musketeer
- `.csv` files obtained using Cary UV/Vis spectrometers
- `.csv` files exported from Mnova as "NMR 1D Peak List"
For other data sources, select **Create a new fit file**, and click **Enter/edit spectroscopic data**. This will open a spreadsheet interface where you can type or paste titration data. If you would like to request support for a new file format, please describe it by [submitting a feature request](https://github.com/daniilS/Musketeer/issues/new)!
### Model specification
Once a file is loaded, the left side of the window will show a series of dropdown menus. Going from top to bottom, each of these can be adjusted to describe some part of the model:
- The _Experiment_ section allows you to edit the signals to fit, specify the concentrations or cumulative addition volumes for each data point, and whether the system is under fast or slow exchange.
- The _Equilibria_ section allows you to define the complexes formed in your system, and specify known values for equilibrium constants or relationships between them (such as the absence of cooperativity).
- The _Spectra_ section allows you to define which compounds contribute to the observed signal, limit the number of variables by defining specific states that contribute to the signals (e.g. spectroscopically active groups), fix known spectra, or constrain the fitted spectra (e.g. force UV-Vis spectra to be non-negative).
- The _Fitting_ section controls how the fit from different signals is weighted, which is currently only recommended for backwards compatibility.
If a dropdown requires you to input more data, it will show more information at the top of a popup window.
### Fitting
When you have selected the appropriate option in each dropdown, press **Fit** to fit the data. Several tabs will appear, showing the fit to the data points, the calculated speciation, and the fitted equilibrium constants and spectra. The save button to the bottom left of each plot allows you to save it as an image file.
To compare the fit to a different model, **Copy fit** can create a new tab with the same options, some of which can then be modified. If you change any options, it may be necessary to re-enter the dropdowns below it as well: for example, if you add a new complex, you may need to re-enter which equilibrium constants are fixed.
Finally, the **File->Save** at the top of the screen allows you to save your work as a `.fit` file, which you can reopen at another time, or share with others.
Raw data
{
"_id": null,
"home_page": "https://github.com/daniilS/Musketeer",
"name": "musketeer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Daniil Soloviev",
"author_email": "dos23@cam.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/2f/b9/01a20b78937d85ffeb3b1db71c72bc579fb602ffd59fff8a78bf9f6406ed/musketeer-1.8.1.tar.gz",
"platform": null,
"description": "# Musketeer\r\nA software tool for fitting data from titration experiments.\r\n## Installation\r\n### Windows & MacOS:\r\nYou can install the latest .msi or .dmg installer [here](https://github.com/daniilS/Musketeer/releases/latest).\r\n### Any platform (requires Python)\r\nInstall the latest release of python from [the official website](https://www.python.org/downloads/). Then, in a terminal window or command prompt, type:\r\n- Mac: `python3 -m pip install musketeer`\r\n- Windows: `python -m pip install musketeer`\r\n\r\nYou can now run Musketeer any time by typing:\r\n- Mac: `python3 -m musketeer`\r\n- Windows: `python -m musketeer`\r\n## Usage Instructions\r\n### Example files\r\nTwo example files are provided:\r\n\r\n- [A UV-Vis titration with guest absorption](examples/UV-Vis_example.fit?raw=1), from https://doi.org/10.1039/D2SC04271A\r\n- [A 31-P NMR denaturation experiment](examples/NMR_example.fit?raw=1), from https://doi.org/10.1039/D1SC02288A\r\n### Loading titration data\r\nWhen starting Musketeer, you will see the option to either **Create a new fit file** or **Open an existing file**. Musketeer can directly open the following files:\r\n\r\n- `.fit` files created using Musketeer\r\n- `.csv` files obtained using Cary UV/Vis spectrometers\r\n- `.csv` files exported from Mnova as \"NMR 1D Peak List\"\r\n\r\nFor other data sources, select **Create a new fit file**, and click **Enter/edit spectroscopic data**. This will open a spreadsheet interface where you can type or paste titration data. If you would like to request support for a new file format, please describe it by [submitting a feature request](https://github.com/daniilS/Musketeer/issues/new)!\r\n### Model specification \r\nOnce a file is loaded, the left side of the window will show a series of dropdown menus. Going from top to bottom, each of these can be adjusted to describe some part of the model:\r\n\r\n- The _Experiment_ section allows you to edit the signals to fit, specify the concentrations or cumulative addition volumes for each data point, and whether the system is under fast or slow exchange.\r\n- The _Equilibria_ section allows you to define the complexes formed in your system, and specify known values for equilibrium constants or relationships between them (such as the absence of cooperativity).\r\n- The _Spectra_ section allows you to define which compounds contribute to the observed signal, limit the number of variables by defining specific states that contribute to the signals (e.g. spectroscopically active groups), fix known spectra, or constrain the fitted spectra (e.g. force UV-Vis spectra to be non-negative).\r\n- The _Fitting_ section controls how the fit from different signals is weighted, which is currently only recommended for backwards compatibility.\r\n\r\nIf a dropdown requires you to input more data, it will show more information at the top of a popup window.\r\n### Fitting\r\nWhen you have selected the appropriate option in each dropdown, press **Fit** to fit the data. Several tabs will appear, showing the fit to the data points, the calculated speciation, and the fitted equilibrium constants and spectra. The save button to the bottom left of each plot allows you to save it as an image file.\r\n\r\nTo compare the fit to a different model, **Copy fit** can create a new tab with the same options, some of which can then be modified. If you change any options, it may be necessary to re-enter the dropdowns below it as well: for example, if you add a new complex, you may need to re-enter which equilibrium constants are fixed.\r\n\r\nFinally, the **File->Save** at the top of the screen allows you to save your work as a `.fit` file, which you can reopen at another time, or share with others.\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool for fitting data from titration experiments.",
"version": "1.8.1",
"project_urls": {
"Homepage": "https://github.com/daniilS/Musketeer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1dc6482773a74e860f05727e8d90bb331afa8e1a10f84ff0f904cc8ae02635d3",
"md5": "73b58a867a52ae49e0f00669edd75afe",
"sha256": "fe73ecaa8606dd96953c4a47448456c11048a12f87c6b9deff32414720a86799"
},
"downloads": -1,
"filename": "musketeer-1.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73b58a867a52ae49e0f00669edd75afe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 115227,
"upload_time": "2024-09-03T16:38:00",
"upload_time_iso_8601": "2024-09-03T16:38:00.337798Z",
"url": "https://files.pythonhosted.org/packages/1d/c6/482773a74e860f05727e8d90bb331afa8e1a10f84ff0f904cc8ae02635d3/musketeer-1.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2fb901a20b78937d85ffeb3b1db71c72bc579fb602ffd59fff8a78bf9f6406ed",
"md5": "7696a393d9f5e3d4bb6d23353121cbde",
"sha256": "8cdeaaa956fe0d39e11450bad29b0f2763935dbf526d24a0f99771b8ccae8276"
},
"downloads": -1,
"filename": "musketeer-1.8.1.tar.gz",
"has_sig": false,
"md5_digest": "7696a393d9f5e3d4bb6d23353121cbde",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 247920,
"upload_time": "2024-09-03T16:38:01",
"upload_time_iso_8601": "2024-09-03T16:38:01.716983Z",
"url": "https://files.pythonhosted.org/packages/2f/b9/01a20b78937d85ffeb3b1db71c72bc579fb602ffd59fff8a78bf9f6406ed/musketeer-1.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-03 16:38:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daniilS",
"github_project": "Musketeer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "musketeer"
}
JSON
