A web app to quickly triage molecule files.
Project description
MolSelector
MolSelector is a lightweight web app for triaging molecular structures (.xyz, .mol, .mol2). Point the app at a folder of files, explore each molecule in an interactive 3D viewer powered by 3Dmol.js, and rapidly tag it as accept or decline. Decisions are written to selection_results.csv in the chosen folder so they can be versioned or analyzed later.
Features
- Fast folder loading with support for
.xyz,.mol, and.mol2files (non-recursive) - Interactive 3D visualization using sticks and spheres with customizable styling
- Accept, decline, and back actions with mouse or keyboard shortcuts
- Automatic CSV logging with timestamps so you can stop and resume reviews anytime
Requirements
- Python 3.12+
- A modern browser with WebGL support (Chrome, Firefox, Safari, Edge)
Installation
pip install molselector
Running the app
Start a local server with the built-in CLI:
molselector launch
Open your browser to http://127.0.0.1:8000 and MolSelector will be ready. The CLI exposes options such as --host, --port, and --log-level; use molselector launch --help to view them. You can still start the app manually with uvicorn molselector.app:app if you prefer.
To preload a folder of molecules (skipping the manual selection step), supply the --xyz-folder option:
molselector launch --xyz-folder /path/to/molecules
The browser will automatically load that folder when the UI opens.
Usage
- Enter an absolute path to a folder containing
.xyz,.mol, or.mol2files, or click Browse… to pick a folder using the native dialog. - MolSelector lists every supported file in the folder and loads the first unreviewed molecule in the embedded 3D viewer.
- Inspect the structure, then use Accept, Decline, or Back to record your judgment. Decisions are saved instantly to
selection_results.csvin the same folder. - Reloading the same folder restores previous decisions so you can resume where you left off.
Keyboard shortcuts
Enter,A, or→: accept the current moleculeDor←: decline the current moleculeBackspace,B, or↑: go back to the previous molecule
Output format
The CSV file (selection_results.csv) contains three columns:
| column | description |
|---|---|
file |
Relative path to the molecule inside the selected folder |
decision |
Either accept or decline |
timestamp |
UTC timestamp recorded at the decision moment |
Contributing
Contributions are welcome! If you have ideas for improvements—batch actions, recursive search, alternate viewers—open an issue or submit a pull request describing the change.
License
MIT License
Copyright (c) 2025 Nicholas Hadler
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file molselector-1.1.1.tar.gz.
File metadata
- Download URL: molselector-1.1.1.tar.gz
- Upload date:
- Size: 13.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e3ebdb6628b05e687076b65eb4145efa2600db97549805e8f511c032abf69be
|
|
| MD5 |
089fe061ea4c099cc66e4eaefc9572ba
|
|
| BLAKE2b-256 |
86fb369274ab9c9e4613fdf9fd66f7cdc3a8a5987c45ef0c50a0fc2ee77dd611
|
File details
Details for the file molselector-1.1.1-py3-none-any.whl.
File metadata
- Download URL: molselector-1.1.1-py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa70431cad9a33cbd1d12479b9f6bc76b8ff1c45f05bbc69f043247b50402628
|
|
| MD5 |
07619d73820b75a3ce28ac574fd1daec
|
|
| BLAKE2b-256 |
de14396d244ecee0819330b6f54cdddad9a20ec412e575e7c9d84a4dcde3c0a2
|