legend1234 JackyZzZzZ commited on
Commit
bbcd4a0
·
unverified ·
1 Parent(s): 1b2c715

Initial draft (#252)

Browse files

* Initial Commit

* Added the pipeline workflow for Docker and HuggingFace

* Added Dockerfile

* Added intro and maxmin interface

* Added the configuration file for HuggingFace space

* Update README for webapp

* Removed Selector package from webapp

* Install selector package in the container directly

* Optimize the Dockerfile for simplicity

* Removed unused files

* Optimized the workflow

* Test the workflow

* Fix unused code in Dockerfile

* Added instructions for running webapp in README

* Unified the name of selector

* Added a common module to reduce duplication

* Optimized MaxMin

* Added MaxSum Interface

* Added DISE Interface

* Added OptiSim Interface

* Added GridPartition Interface

* Added Medoid Interface

* Added helper module for converter

* Added Converter Interface

* Fixed some bug with the container environment

* Fixed ordering problem in README

---------

Co-authored-by: Jun Xia <xiaj8@uci.edu>

.github/CODE_OF_CONDUCT.md ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ It is recommended to follow the code of conduct as described in
4
+ https://qcdevs.org/guidelines/QCDevsCodeOfConduct/.
.github/CONTRIBUTING.md ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # How to contribute
2
+
3
+ We welcome contributions from external contributors, and this document
4
+ describes how to merge code changes into this selector.
5
+
6
+ ## Getting Started
7
+
8
+ * Make sure you have a [GitHub account](https://github.com/signup/free).
9
+ * [Fork](https://help.github.com/articles/fork-a-repo/) this repository on GitHub.
10
+ * On your local machine,
11
+ [clone](https://help.github.com/articles/cloning-a-repository/) your fork of
12
+ the repository.
13
+
14
+ ## Making Changes
15
+
16
+ * Add some really awesome code to your local fork. It's usually a
17
+ [good idea](http://blog.jasonmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch/)
18
+ to make changes on a
19
+ [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
20
+ with the branch name relating to the feature you are going to add.
21
+ * When you are ready for others to examine and comment on your new feature,
22
+ navigate to your fork of selector on GitHub and open a
23
+ * [pull request](https://help.github.com/articles/using-pull-requests/) (PR). Note that
24
+ after you launch a PR from one of your fork's branches, all
25
+ subsequent commits to that branch will be added to the open pull request
26
+ automatically. Each commit added to the PR will be validated for
27
+ mergability, compilation and test suite compliance; the results of these tests
28
+ will be visible on the PR page.
29
+ * If you're providing a new feature, you must add test cases and documentation.
30
+ * When the code is ready to go, make sure you run the test suite using pytest.
31
+ * When you're ready to be considered for merging, check the "Ready to go"
32
+ box on the PR page to let the selector devs know that the changes are complete.
33
+ The code will not be merged until this box is checked, the continuous
34
+ integration returns checkmarks,
35
+ and multiple core developers give "Approved" reviews.
36
+
37
+ # Python Virtual Environment for Package Development
38
+
39
+ Here is a list of version information for different packages that we used for
40
+ [selector](https://github.com/theochem/selector),
41
+
42
+ ```bash
43
+ python==3.7.11
44
+ rdkit==2020.09.1.0
45
+ numpy==1.21.2
46
+ scipy==1.7.3
47
+ pytest==6.2.5
48
+ pytest-cov==3.0.0
49
+ tox==3.24.5
50
+ flake8==4.0.1
51
+ pylint==2.12.2
52
+ codecov=2.1.12
53
+ # more to be added
54
+ ```
55
+
56
+ `Conda`, [`venv`](https://docs.python.org/3/library/venv.html#module-venv) and
57
+ [`virtualenv`](https://virtualenv.pypa.io/en/latest/) are your good friends and anyone of them
58
+ is very helpful. I prefer `Miniconda` on my local machine.
59
+
60
+ # Additional Resources
61
+
62
+ * [General GitHub documentation](https://help.github.com/)
63
+ * [PR best practices](http://codeinthehole.com/writing/pull-requests-and-other-good-practices-for-teams-using-github/)
64
+ * [A guide to contributing to software packages](http://www.contribution-guide.org)
65
+ * [Thinkful PR example](http://www.thinkful.com/learn/github-pull-request-tutorial/#Time-to-Submit-Your-First-PR)
.github/workflows/interface_auto.yml ADDED
@@ -0,0 +1,63 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Deployment on DockerHub and Hugging Face
2
+
3
+ # Trigger the workflow on push and pull request events to the 'main' or 'master' branch
4
+ on:
5
+ push:
6
+ branches:
7
+ - "master"
8
+ - "main"
9
+ - "webapp"
10
+ - "jun-intro-maxmin"
11
+ pull_request:
12
+ branches:
13
+ - "master"
14
+ - "main"
15
+ - "webapp"
16
+
17
+ jobs:
18
+ build-and-deploy:
19
+ # Run the job on the latest Ubuntu runner
20
+ runs-on: ubuntu-latest
21
+
22
+ steps:
23
+ # Step 1: Check out the latest code from the repository
24
+ - name: Checkout code
25
+ uses: actions/checkout@v4
26
+ with:
27
+ fetch-depth: 0
28
+ lfs: true
29
+
30
+ # Step 2: Set up Python environment with version 3.11
31
+ - name: Set up Python
32
+ uses: actions/setup-python@v5
33
+ with:
34
+ python-version: 3.11
35
+
36
+ # Step 3: Build the Docker image to Docker Hub
37
+ - name: Build Docker image
38
+ run: |
39
+ docker build . -t qcdevs/selector:latest
40
+
41
+ # Step 4: Push the Docker image to Docker Hub
42
+ - name: Push Docker image
43
+ env:
44
+ DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
45
+ run: |
46
+ docker login -u qcdevs -p $DOCKERHUB_TOKEN
47
+ docker push qcdevs/selector:latest
48
+
49
+ # Step 5: Replace the README.md file for Hugging Face
50
+ - name: Replace README for Hugging Face
51
+ run: |
52
+ mv README_hf.md README.md
53
+ git config --global user.name "github-actions[bot]"
54
+ git config --global user.email "qcdevs@gmail.com"
55
+ git add README.md
56
+ git commit -m "Replace README.md with README_hf.md for Hugging Face"
57
+
58
+ # Step 6: Push the app to Hugging Face
59
+ - name: Push to Hugging Face
60
+ env:
61
+ HF_TOKEN: ${{ secrets.HF_TOKEN }}
62
+ run: |
63
+ git push https://QCDevs:$HF_TOKEN@huggingface.co/spaces/QCDevs/selector HEAD:main --force
.gitignore ADDED
@@ -0,0 +1,161 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ doc/_build/
73
+ doc/html/
74
+ doc/latex/
75
+ doc/man/
76
+ doc/xml/
77
+ doc/source
78
+ doc/modules
79
+
80
+ # PyBuilder
81
+ target/
82
+
83
+ # Jupyter Notebook
84
+ .ipynb_checkpoints
85
+
86
+ # IPython
87
+ profile_default/
88
+ ipython_config.py
89
+
90
+ # pyenv
91
+ .python-version
92
+
93
+ # pipenv
94
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
95
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
96
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
97
+ # install all needed dependencies.
98
+ #Pipfile.lock
99
+
100
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
101
+ __pypackages__/
102
+
103
+ # Celery stuff
104
+ celerybeat-schedule
105
+ celerybeat.pid
106
+
107
+ # SageMath parsed files
108
+ *.sage.py
109
+
110
+ # Environments
111
+ .env
112
+ .venv
113
+ env/
114
+ venv/
115
+ ENV/
116
+ env.bak/
117
+ venv.bak/
118
+
119
+ # Spyder project settings
120
+ .spyderproject
121
+ .spyproject
122
+
123
+ # Rope project settings
124
+ .ropeproject
125
+
126
+ # mkdocs documentation
127
+ /site
128
+
129
+ # mypy
130
+ .mypy_cache/
131
+ .dmypy.json
132
+ dmypy.json
133
+
134
+ # Pyre type checker
135
+ .pyre/
136
+
137
+ # Editor junk
138
+ tags
139
+ [._]*.s[a-v][a-z]
140
+ [._]*.sw[a-p]
141
+ [._]s[a-v][a-z]
142
+ [._]sw[a-p]
143
+ *~
144
+ \#*\#
145
+ .\#*
146
+ .ropeproject
147
+ .idea/
148
+ .spyderproject
149
+ .spyproject
150
+ .vscode/
151
+ # Mac .DS_Store
152
+ .DS_Store
153
+
154
+ # jupyter notebook checkpoints
155
+ .ipynb_checkpoints
156
+
157
+ # codecov files
158
+ *.gcno
159
+ *.gcda
160
+ *.gcov
161
+ test_calculator
Dockerfile ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Use the official image as a parent image
2
+ FROM python:3.11-slim
3
+
4
+ # Set the working directory in the container
5
+ WORKDIR /app
6
+
7
+ # Install system dependencies required for building packages
8
+ RUN apt-get update && \
9
+ apt-get install -y build-essential git && \
10
+ apt-get install -y libxrender1 libxext6 && \
11
+ apt-get clean
12
+
13
+ # Upgrade pip
14
+ RUN pip install --upgrade pip
15
+
16
+ # Install dependencies
17
+ RUN pip install streamlit rdkit
18
+
19
+ # Install the Selector package from the source code
20
+ RUN pip install git+https://github.com/theochem/Selector.git
21
+
22
+ # Copy the rest of the application code
23
+ COPY . .
24
+
25
+ # Expose the port the app runs on
26
+ EXPOSE 8501
27
+
28
+ # Command to run the app
29
+ CMD ["streamlit", "run", "streamlit_app/app.py", "--server.enableXsrfProtection=false"]
LICENSE ADDED
@@ -0,0 +1,674 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+ Preamble
9
+
10
+ The GNU General Public License is a free, copyleft license for
11
+ software and other kinds of works.
12
+
13
+ The licenses for most software and other practical works are designed
14
+ to take away your freedom to share and change the works. By contrast,
15
+ the GNU General Public License is intended to guarantee your freedom to
16
+ share and change all versions of a program--to make sure it remains free
17
+ software for all its users. We, the Free Software Foundation, use the
18
+ GNU General Public License for most of our software; it applies also to
19
+ any other work released this way by its authors. You can apply it to
20
+ your programs, too.
21
+
22
+ When we speak of free software, we are referring to freedom, not
23
+ price. Our General Public Licenses are designed to make sure that you
24
+ have the freedom to distribute copies of free software (and charge for
25
+ them if you wish), that you receive source code or can get it if you
26
+ want it, that you can change the software or use pieces of it in new
27
+ free programs, and that you know you can do these things.
28
+
29
+ To protect your rights, we need to prevent others from denying you
30
+ these rights or asking you to surrender the rights. Therefore, you have
31
+ certain responsibilities if you distribute copies of the software, or if
32
+ you modify it: responsibilities to respect the freedom of others.
33
+
34
+ For example, if you distribute copies of such a program, whether
35
+ gratis or for a fee, you must pass on to the recipients the same
36
+ freedoms that you received. You must make sure that they, too, receive
37
+ or can get the source code. And you must show them these terms so they
38
+ know their rights.
39
+
40
+ Developers that use the GNU GPL protect your rights with two steps:
41
+ (1) assert copyright on the software, and (2) offer you this License
42
+ giving you legal permission to copy, distribute and/or modify it.
43
+
44
+ For the developers' and authors' protection, the GPL clearly explains
45
+ that there is no warranty for this free software. For both users' and
46
+ authors' sake, the GPL requires that modified versions be marked as
47
+ changed, so that their problems will not be attributed erroneously to
48
+ authors of previous versions.
49
+
50
+ Some devices are designed to deny users access to install or run
51
+ modified versions of the software inside them, although the manufacturer
52
+ can do so. This is fundamentally incompatible with the aim of
53
+ protecting users' freedom to change the software. The systematic
54
+ pattern of such abuse occurs in the area of products for individuals to
55
+ use, which is precisely where it is most unacceptable. Therefore, we
56
+ have designed this version of the GPL to prohibit the practice for those
57
+ products. If such problems arise substantially in other domains, we
58
+ stand ready to extend this provision to those domains in future versions
59
+ of the GPL, as needed to protect the freedom of users.
60
+
61
+ Finally, every program is threatened constantly by software patents.
62
+ States should not allow patents to restrict development and use of
63
+ software on general-purpose computers, but in those that do, we wish to
64
+ avoid the special danger that patents applied to a free program could
65
+ make it effectively proprietary. To prevent this, the GPL assures that
66
+ patents cannot be used to render the program non-free.
67
+
68
+ The precise terms and conditions for copying, distribution and
69
+ modification follow.
70
+
71
+ TERMS AND CONDITIONS
72
+
73
+ 0. Definitions.
74
+
75
+ "This License" refers to version 3 of the GNU General Public License.
76
+
77
+ "Copyright" also means copyright-like laws that apply to other kinds of
78
+ works, such as semiconductor masks.
79
+
80
+ "The Program" refers to any copyrightable work licensed under this
81
+ License. Each licensee is addressed as "you". "Licensees" and
82
+ "recipients" may be individuals or organizations.
83
+
84
+ To "modify" a work means to copy from or adapt all or part of the work
85
+ in a fashion requiring copyright permission, other than the making of an
86
+ exact copy. The resulting work is called a "modified version" of the
87
+ earlier work or a work "based on" the earlier work.
88
+
89
+ A "covered work" means either the unmodified Program or a work based
90
+ on the Program.
91
+
92
+ To "propagate" a work means to do anything with it that, without
93
+ permission, would make you directly or secondarily liable for
94
+ infringement under applicable copyright law, except executing it on a
95
+ computer or modifying a private copy. Propagation includes copying,
96
+ distribution (with or without modification), making available to the
97
+ public, and in some countries other activities as well.
98
+
99
+ To "convey" a work means any kind of propagation that enables other
100
+ parties to make or receive copies. Mere interaction with a user through
101
+ a computer network, with no transfer of a copy, is not conveying.
102
+
103
+ An interactive user interface displays "Appropriate Legal Notices"
104
+ to the extent that it includes a convenient and prominently visible
105
+ feature that (1) displays an appropriate copyright notice, and (2)
106
+ tells the user that there is no warranty for the work (except to the
107
+ extent that warranties are provided), that licensees may convey the
108
+ work under this License, and how to view a copy of this License. If
109
+ the interface presents a list of user commands or options, such as a
110
+ menu, a prominent item in the list meets this criterion.
111
+
112
+ 1. Source Code.
113
+
114
+ The "source code" for a work means the preferred form of the work
115
+ for making modifications to it. "Object code" means any non-source
116
+ form of a work.
117
+
118
+ A "Standard Interface" means an interface that either is an official
119
+ standard defined by a recognized standards body, or, in the case of
120
+ interfaces specified for a particular programming language, one that
121
+ is widely used among developers working in that language.
122
+
123
+ The "System Libraries" of an executable work include anything, other
124
+ than the work as a whole, that (a) is included in the normal form of
125
+ packaging a Major Component, but which is not part of that Major
126
+ Component, and (b) serves only to enable use of the work with that
127
+ Major Component, or to implement a Standard Interface for which an
128
+ implementation is available to the public in source code form. A
129
+ "Major Component", in this context, means a major essential component
130
+ (kernel, window system, and so on) of the specific operating system
131
+ (if any) on which the executable work runs, or a compiler used to
132
+ produce the work, or an object code interpreter used to run it.
133
+
134
+ The "Corresponding Source" for a work in object code form means all
135
+ the source code needed to generate, install, and (for an executable
136
+ work) run the object code and to modify the work, including scripts to
137
+ control those activities. However, it does not include the work's
138
+ System Libraries, or general-purpose tools or generally available free
139
+ programs which are used unmodified in performing those activities but
140
+ which are not part of the work. For example, Corresponding Source
141
+ includes interface definition files associated with source files for
142
+ the work, and the source code for shared libraries and dynamically
143
+ linked subprograms that the work is specifically designed to require,
144
+ such as by intimate data communication or control flow between those
145
+ subprograms and other parts of the work.
146
+
147
+ The Corresponding Source need not include anything that users
148
+ can regenerate automatically from other parts of the Corresponding
149
+ Source.
150
+
151
+ The Corresponding Source for a work in source code form is that
152
+ same work.
153
+
154
+ 2. Basic Permissions.
155
+
156
+ All rights granted under this License are granted for the term of
157
+ copyright on the Program, and are irrevocable provided the stated
158
+ conditions are met. This License explicitly affirms your unlimited
159
+ permission to run the unmodified Program. The output from running a
160
+ covered work is covered by this License only if the output, given its
161
+ content, constitutes a covered work. This License acknowledges your
162
+ rights of fair use or other equivalent, as provided by copyright law.
163
+
164
+ You may make, run and propagate covered works that you do not
165
+ convey, without conditions so long as your license otherwise remains
166
+ in force. You may convey covered works to others for the sole purpose
167
+ of having them make modifications exclusively for you, or provide you
168
+ with facilities for running those works, provided that you comply with
169
+ the terms of this License in conveying all material for which you do
170
+ not control copyright. Those thus making or running the covered works
171
+ for you must do so exclusively on your behalf, under your direction
172
+ and control, on terms that prohibit them from making any copies of
173
+ your copyrighted material outside their relationship with you.
174
+
175
+ Conveying under any other circumstances is permitted solely under
176
+ the conditions stated below. Sublicensing is not allowed; section 10
177
+ makes it unnecessary.
178
+
179
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
+
181
+ No covered work shall be deemed part of an effective technological
182
+ measure under any applicable law fulfilling obligations under article
183
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
+ similar laws prohibiting or restricting circumvention of such
185
+ measures.
186
+
187
+ When you convey a covered work, you waive any legal power to forbid
188
+ circumvention of technological measures to the extent such circumvention
189
+ is effected by exercising rights under this License with respect to
190
+ the covered work, and you disclaim any intention to limit operation or
191
+ modification of the work as a means of enforcing, against the work's
192
+ users, your or third parties' legal rights to forbid circumvention of
193
+ technological measures.
194
+
195
+ 4. Conveying Verbatim Copies.
196
+
197
+ You may convey verbatim copies of the Program's source code as you
198
+ receive it, in any medium, provided that you conspicuously and
199
+ appropriately publish on each copy an appropriate copyright notice;
200
+ keep intact all notices stating that this License and any
201
+ non-permissive terms added in accord with section 7 apply to the code;
202
+ keep intact all notices of the absence of any warranty; and give all
203
+ recipients a copy of this License along with the Program.
204
+
205
+ You may charge any price or no price for each copy that you convey,
206
+ and you may offer support or warranty protection for a fee.
207
+
208
+ 5. Conveying Modified Source Versions.
209
+
210
+ You may convey a work based on the Program, or the modifications to
211
+ produce it from the Program, in the form of source code under the
212
+ terms of section 4, provided that you also meet all of these conditions:
213
+
214
+ a) The work must carry prominent notices stating that you modified
215
+ it, and giving a relevant date.
216
+
217
+ b) The work must carry prominent notices stating that it is
218
+ released under this License and any conditions added under section
219
+ 7. This requirement modifies the requirement in section 4 to
220
+ "keep intact all notices".
221
+
222
+ c) You must license the entire work, as a whole, under this
223
+ License to anyone who comes into possession of a copy. This
224
+ License will therefore apply, along with any applicable section 7
225
+ additional terms, to the whole of the work, and all its parts,
226
+ regardless of how they are packaged. This License gives no
227
+ permission to license the work in any other way, but it does not
228
+ invalidate such permission if you have separately received it.
229
+
230
+ d) If the work has interactive user interfaces, each must display
231
+ Appropriate Legal Notices; however, if the Program has interactive
232
+ interfaces that do not display Appropriate Legal Notices, your
233
+ work need not make them do so.
234
+
235
+ A compilation of a covered work with other separate and independent
236
+ works, which are not by their nature extensions of the covered work,
237
+ and which are not combined with it such as to form a larger program,
238
+ in or on a volume of a storage or distribution medium, is called an
239
+ "aggregate" if the compilation and its resulting copyright are not
240
+ used to limit the access or legal rights of the compilation's users
241
+ beyond what the individual works permit. Inclusion of a covered work
242
+ in an aggregate does not cause this License to apply to the other
243
+ parts of the aggregate.
244
+
245
+ 6. Conveying Non-Source Forms.
246
+
247
+ You may convey a covered work in object code form under the terms
248
+ of sections 4 and 5, provided that you also convey the
249
+ machine-readable Corresponding Source under the terms of this License,
250
+ in one of these ways:
251
+
252
+ a) Convey the object code in, or embodied in, a physical product
253
+ (including a physical distribution medium), accompanied by the
254
+ Corresponding Source fixed on a durable physical medium
255
+ customarily used for software interchange.
256
+
257
+ b) Convey the object code in, or embodied in, a physical product
258
+ (including a physical distribution medium), accompanied by a
259
+ written offer, valid for at least three years and valid for as
260
+ long as you offer spare parts or customer support for that product
261
+ model, to give anyone who possesses the object code either (1) a
262
+ copy of the Corresponding Source for all the software in the
263
+ product that is covered by this License, on a durable physical
264
+ medium customarily used for software interchange, for a price no
265
+ more than your reasonable cost of physically performing this
266
+ conveying of source, or (2) access to copy the
267
+ Corresponding Source from a network server at no charge.
268
+
269
+ c) Convey individual copies of the object code with a copy of the
270
+ written offer to provide the Corresponding Source. This
271
+ alternative is allowed only occasionally and noncommercially, and
272
+ only if you received the object code with such an offer, in accord
273
+ with subsection 6b.
274
+
275
+ d) Convey the object code by offering access from a designated
276
+ place (gratis or for a charge), and offer equivalent access to the
277
+ Corresponding Source in the same way through the same place at no
278
+ further charge. You need not require recipients to copy the
279
+ Corresponding Source along with the object code. If the place to
280
+ copy the object code is a network server, the Corresponding Source
281
+ may be on a different server (operated by you or a third party)
282
+ that supports equivalent copying facilities, provided you maintain
283
+ clear directions next to the object code saying where to find the
284
+ Corresponding Source. Regardless of what server hosts the
285
+ Corresponding Source, you remain obligated to ensure that it is
286
+ available for as long as needed to satisfy these requirements.
287
+
288
+ e) Convey the object code using peer-to-peer transmission, provided
289
+ you inform other peers where the object code and Corresponding
290
+ Source of the work are being offered to the general public at no
291
+ charge under subsection 6d.
292
+
293
+ A separable portion of the object code, whose source code is excluded
294
+ from the Corresponding Source as a System Library, need not be
295
+ included in conveying the object code work.
296
+
297
+ A "User Product" is either (1) a "consumer product", which means any
298
+ tangible personal property which is normally used for personal, family,
299
+ or household purposes, or (2) anything designed or sold for incorporation
300
+ into a dwelling. In determining whether a product is a consumer product,
301
+ doubtful cases shall be resolved in favor of coverage. For a particular
302
+ product received by a particular user, "normally used" refers to a
303
+ typical or common use of that class of product, regardless of the status
304
+ of the particular user or of the way in which the particular user
305
+ actually uses, or expects or is expected to use, the product. A product
306
+ is a consumer product regardless of whether the product has substantial
307
+ commercial, industrial or non-consumer uses, unless such uses represent
308
+ the only significant mode of use of the product.
309
+
310
+ "Installation Information" for a User Product means any methods,
311
+ procedures, authorization keys, or other information required to install
312
+ and execute modified versions of a covered work in that User Product from
313
+ a modified version of its Corresponding Source. The information must
314
+ suffice to ensure that the continued functioning of the modified object
315
+ code is in no case prevented or interfered with solely because
316
+ modification has been made.
317
+
318
+ If you convey an object code work under this section in, or with, or
319
+ specifically for use in, a User Product, and the conveying occurs as
320
+ part of a transaction in which the right of possession and use of the
321
+ User Product is transferred to the recipient in perpetuity or for a
322
+ fixed term (regardless of how the transaction is characterized), the
323
+ Corresponding Source conveyed under this section must be accompanied
324
+ by the Installation Information. But this requirement does not apply
325
+ if neither you nor any third party retains the ability to install
326
+ modified object code on the User Product (for example, the work has
327
+ been installed in ROM).
328
+
329
+ The requirement to provide Installation Information does not include a
330
+ requirement to continue to provide support service, warranty, or updates
331
+ for a work that has been modified or installed by the recipient, or for
332
+ the User Product in which it has been modified or installed. Access to a
333
+ network may be denied when the modification itself materially and
334
+ adversely affects the operation of the network or violates the rules and
335
+ protocols for communication across the network.
336
+
337
+ Corresponding Source conveyed, and Installation Information provided,
338
+ in accord with this section must be in a format that is publicly
339
+ documented (and with an implementation available to the public in
340
+ source code form), and must require no special password or key for
341
+ unpacking, reading or copying.
342
+
343
+ 7. Additional Terms.
344
+
345
+ "Additional permissions" are terms that supplement the terms of this
346
+ License by making exceptions from one or more of its conditions.
347
+ Additional permissions that are applicable to the entire Program shall
348
+ be treated as though they were included in this License, to the extent
349
+ that they are valid under applicable law. If additional permissions
350
+ apply only to part of the Program, that part may be used separately
351
+ under those permissions, but the entire Program remains governed by
352
+ this License without regard to the additional permissions.
353
+
354
+ When you convey a copy of a covered work, you may at your option
355
+ remove any additional permissions from that copy, or from any part of
356
+ it. (Additional permissions may be written to require their own
357
+ removal in certain cases when you modify the work.) You may place
358
+ additional permissions on material, added by you to a covered work,
359
+ for which you have or can give appropriate copyright permission.
360
+
361
+ Notwithstanding any other provision of this License, for material you
362
+ add to a covered work, you may (if authorized by the copyright holders of
363
+ that material) supplement the terms of this License with terms:
364
+
365
+ a) Disclaiming warranty or limiting liability differently from the
366
+ terms of sections 15 and 16 of this License; or
367
+
368
+ b) Requiring preservation of specified reasonable legal notices or
369
+ author attributions in that material or in the Appropriate Legal
370
+ Notices displayed by works containing it; or
371
+
372
+ c) Prohibiting misrepresentation of the origin of that material, or
373
+ requiring that modified versions of such material be marked in
374
+ reasonable ways as different from the original version; or
375
+
376
+ d) Limiting the use for publicity purposes of names of licensors or
377
+ authors of the material; or
378
+
379
+ e) Declining to grant rights under trademark law for use of some
380
+ trade names, trademarks, or service marks; or
381
+
382
+ f) Requiring indemnification of licensors and authors of that
383
+ material by anyone who conveys the material (or modified versions of
384
+ it) with contractual assumptions of liability to the recipient, for
385
+ any liability that these contractual assumptions directly impose on
386
+ those licensors and authors.
387
+
388
+ All other non-permissive additional terms are considered "further
389
+ restrictions" within the meaning of section 10. If the Program as you
390
+ received it, or any part of it, contains a notice stating that it is
391
+ governed by this License along with a term that is a further
392
+ restriction, you may remove that term. If a license document contains
393
+ a further restriction but permits relicensing or conveying under this
394
+ License, you may add to a covered work material governed by the terms
395
+ of that license document, provided that the further restriction does
396
+ not survive such relicensing or conveying.
397
+
398
+ If you add terms to a covered work in accord with this section, you
399
+ must place, in the relevant source files, a statement of the
400
+ additional terms that apply to those files, or a notice indicating
401
+ where to find the applicable terms.
402
+
403
+ Additional terms, permissive or non-permissive, may be stated in the
404
+ form of a separately written license, or stated as exceptions;
405
+ the above requirements apply either way.
406
+
407
+ 8. Termination.
408
+
409
+ You may not propagate or modify a covered work except as expressly
410
+ provided under this License. Any attempt otherwise to propagate or
411
+ modify it is void, and will automatically terminate your rights under
412
+ this License (including any patent licenses granted under the third
413
+ paragraph of section 11).
414
+
415
+ However, if you cease all violation of this License, then your
416
+ license from a particular copyright holder is reinstated (a)
417
+ provisionally, unless and until the copyright holder explicitly and
418
+ finally terminates your license, and (b) permanently, if the copyright
419
+ holder fails to notify you of the violation by some reasonable means
420
+ prior to 60 days after the cessation.
421
+
422
+ Moreover, your license from a particular copyright holder is
423
+ reinstated permanently if the copyright holder notifies you of the
424
+ violation by some reasonable means, this is the first time you have
425
+ received notice of violation of this License (for any work) from that
426
+ copyright holder, and you cure the violation prior to 30 days after
427
+ your receipt of the notice.
428
+
429
+ Termination of your rights under this section does not terminate the
430
+ licenses of parties who have received copies or rights from you under
431
+ this License. If your rights have been terminated and not permanently
432
+ reinstated, you do not qualify to receive new licenses for the same
433
+ material under section 10.
434
+
435
+ 9. Acceptance Not Required for Having Copies.
436
+
437
+ You are not required to accept this License in order to receive or
438
+ run a copy of the Program. Ancillary propagation of a covered work
439
+ occurring solely as a consequence of using peer-to-peer transmission
440
+ to receive a copy likewise does not require acceptance. However,
441
+ nothing other than this License grants you permission to propagate or
442
+ modify any covered work. These actions infringe copyright if you do
443
+ not accept this License. Therefore, by modifying or propagating a
444
+ covered work, you indicate your acceptance of this License to do so.
445
+
446
+ 10. Automatic Licensing of Downstream Recipients.
447
+
448
+ Each time you convey a covered work, the recipient automatically
449
+ receives a license from the original licensors, to run, modify and
450
+ propagate that work, subject to this License. You are not responsible
451
+ for enforcing compliance by third parties with this License.
452
+
453
+ An "entity transaction" is a transaction transferring control of an
454
+ organization, or substantially all assets of one, or subdividing an
455
+ organization, or merging organizations. If propagation of a covered
456
+ work results from an entity transaction, each party to that
457
+ transaction who receives a copy of the work also receives whatever
458
+ licenses to the work the party's predecessor in interest had or could
459
+ give under the previous paragraph, plus a right to possession of the
460
+ Corresponding Source of the work from the predecessor in interest, if
461
+ the predecessor has it or can get it with reasonable efforts.
462
+
463
+ You may not impose any further restrictions on the exercise of the
464
+ rights granted or affirmed under this License. For example, you may
465
+ not impose a license fee, royalty, or other charge for exercise of
466
+ rights granted under this License, and you may not initiate litigation
467
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
468
+ any patent claim is infringed by making, using, selling, offering for
469
+ sale, or importing the Program or any portion of it.
470
+
471
+ 11. Patents.
472
+
473
+ A "contributor" is a copyright holder who authorizes use under this
474
+ License of the Program or a work on which the Program is based. The
475
+ work thus licensed is called the contributor's "contributor version".
476
+
477
+ A contributor's "essential patent claims" are all patent claims
478
+ owned or controlled by the contributor, whether already acquired or
479
+ hereafter acquired, that would be infringed by some manner, permitted
480
+ by this License, of making, using, or selling its contributor version,
481
+ but do not include claims that would be infringed only as a
482
+ consequence of further modification of the contributor version. For
483
+ purposes of this definition, "control" includes the right to grant
484
+ patent sublicenses in a manner consistent with the requirements of
485
+ this License.
486
+
487
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
488
+ patent license under the contributor's essential patent claims, to
489
+ make, use, sell, offer for sale, import and otherwise run, modify and
490
+ propagate the contents of its contributor version.
491
+
492
+ In the following three paragraphs, a "patent license" is any express
493
+ agreement or commitment, however denominated, not to enforce a patent
494
+ (such as an express permission to practice a patent or covenant not to
495
+ sue for patent infringement). To "grant" such a patent license to a
496
+ party means to make such an agreement or commitment not to enforce a
497
+ patent against the party.
498
+
499
+ If you convey a covered work, knowingly relying on a patent license,
500
+ and the Corresponding Source of the work is not available for anyone
501
+ to copy, free of charge and under the terms of this License, through a
502
+ publicly available network server or other readily accessible means,
503
+ then you must either (1) cause the Corresponding Source to be so
504
+ available, or (2) arrange to deprive yourself of the benefit of the
505
+ patent license for this particular work, or (3) arrange, in a manner
506
+ consistent with the requirements of this License, to extend the patent
507
+ license to downstream recipients. "Knowingly relying" means you have
508
+ actual knowledge that, but for the patent license, your conveying the
509
+ covered work in a country, or your recipient's use of the covered work
510
+ in a country, would infringe one or more identifiable patents in that
511
+ country that you have reason to believe are valid.
512
+
513
+ If, pursuant to or in connection with a single transaction or
514
+ arrangement, you convey, or propagate by procuring conveyance of, a
515
+ covered work, and grant a patent license to some of the parties
516
+ receiving the covered work authorizing them to use, propagate, modify
517
+ or convey a specific copy of the covered work, then the patent license
518
+ you grant is automatically extended to all recipients of the covered
519
+ work and works based on it.
520
+
521
+ A patent license is "discriminatory" if it does not include within
522
+ the scope of its coverage, prohibits the exercise of, or is
523
+ conditioned on the non-exercise of one or more of the rights that are
524
+ specifically granted under this License. You may not convey a covered
525
+ work if you are a party to an arrangement with a third party that is
526
+ in the business of distributing software, under which you make payment
527
+ to the third party based on the extent of your activity of conveying
528
+ the work, and under which the third party grants, to any of the
529
+ parties who would receive the covered work from you, a discriminatory
530
+ patent license (a) in connection with copies of the covered work
531
+ conveyed by you (or copies made from those copies), or (b) primarily
532
+ for and in connection with specific products or compilations that
533
+ contain the covered work, unless you entered into that arrangement,
534
+ or that patent license was granted, prior to 28 March 2007.
535
+
536
+ Nothing in this License shall be construed as excluding or limiting
537
+ any implied license or other defenses to infringement that may
538
+ otherwise be available to you under applicable patent law.
539
+
540
+ 12. No Surrender of Others' Freedom.
541
+
542
+ If conditions are imposed on you (whether by court order, agreement or
543
+ otherwise) that contradict the conditions of this License, they do not
544
+ excuse you from the conditions of this License. If you cannot convey a
545
+ covered work so as to satisfy simultaneously your obligations under this
546
+ License and any other pertinent obligations, then as a consequence you may
547
+ not convey it at all. For example, if you agree to terms that obligate you
548
+ to collect a royalty for further conveying from those to whom you convey
549
+ the Program, the only way you could satisfy both those terms and this
550
+ License would be to refrain entirely from conveying the Program.
551
+
552
+ 13. Use with the GNU Affero General Public License.
553
+
554
+ Notwithstanding any other provision of this License, you have
555
+ permission to link or combine any covered work with a work licensed
556
+ under version 3 of the GNU Affero General Public License into a single
557
+ combined work, and to convey the resulting work. The terms of this
558
+ License will continue to apply to the part which is the covered work,
559
+ but the special requirements of the GNU Affero General Public License,
560
+ section 13, concerning interaction through a network will apply to the
561
+ combination as such.
562
+
563
+ 14. Revised Versions of this License.
564
+
565
+ The Free Software Foundation may publish revised and/or new versions of
566
+ the GNU General Public License from time to time. Such new versions will
567
+ be similar in spirit to the present version, but may differ in detail to
568
+ address new problems or concerns.
569
+
570
+ Each version is given a distinguishing version number. If the
571
+ Program specifies that a certain numbered version of the GNU General
572
+ Public License "or any later version" applies to it, you have the
573
+ option of following the terms and conditions either of that numbered
574
+ version or of any later version published by the Free Software
575
+ Foundation. If the Program does not specify a version number of the
576
+ GNU General Public License, you may choose any version ever published
577
+ by the Free Software Foundation.
578
+
579
+ If the Program specifies that a proxy can decide which future
580
+ versions of the GNU General Public License can be used, that proxy's
581
+ public statement of acceptance of a version permanently authorizes you
582
+ to choose that version for the Program.
583
+
584
+ Later license versions may give you additional or different
585
+ permissions. However, no additional obligations are imposed on any
586
+ author or copyright holder as a result of your choosing to follow a
587
+ later version.
588
+
589
+ 15. Disclaimer of Warranty.
590
+
591
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
+
600
+ 16. Limitation of Liability.
601
+
602
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
+ SUCH DAMAGES.
611
+
612
+ 17. Interpretation of Sections 15 and 16.
613
+
614
+ If the disclaimer of warranty and limitation of liability provided
615
+ above cannot be given local legal effect according to their terms,
616
+ reviewing courts shall apply local law that most closely approximates
617
+ an absolute waiver of all civil liability in connection with the
618
+ Program, unless a warranty or assumption of liability accompanies a
619
+ copy of the Program in return for a fee.
620
+
621
+ END OF TERMS AND CONDITIONS
622
+
623
+ How to Apply These Terms to Your New Programs
624
+
625
+ If you develop a new program, and you want it to be of the greatest
626
+ possible use to the public, the best way to achieve this is to make it
627
+ free software which everyone can redistribute and change under these terms.
628
+
629
+ To do so, attach the following notices to the program. It is safest
630
+ to attach them to the start of each source file to most effectively
631
+ state the exclusion of warranty; and each file should have at least
632
+ the "copyright" line and a pointer to where the full notice is found.
633
+
634
+ {one line to give the program's name and a brief idea of what it does.}
635
+ Copyright (C) {year} {name of author}
636
+
637
+ This program is free software: you can redistribute it and/or modify
638
+ it under the terms of the GNU General Public License as published by
639
+ the Free Software Foundation, either version 3 of the License, or
640
+ (at your option) any later version.
641
+
642
+ This program is distributed in the hope that it will be useful,
643
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
644
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645
+ GNU General Public License for more details.
646
+
647
+ You should have received a copy of the GNU General Public License
648
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
649
+
650
+ Also add information on how to contact you by electronic and paper mail.
651
+
652
+ If the program does terminal interaction, make it output a short
653
+ notice like this when it starts in an interactive mode:
654
+
655
+ {project} Copyright (C) {year} {fullname}
656
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
+ This is free software, and you are welcome to redistribute it
658
+ under certain conditions; type `show c' for details.
659
+
660
+ The hypothetical commands `show w' and `show c' should show the appropriate
661
+ parts of the General Public License. Of course, your program's commands
662
+ might be different; for a GUI interface, you would use an "about box".
663
+
664
+ You should also get your employer (if you work as a programmer) or school,
665
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
666
+ For more information on this, and how to apply and follow the GNU GPL, see
667
+ <http://www.gnu.org/licenses/>.
668
+
669
+ The GNU General Public License does not permit incorporating your program
670
+ into proprietary programs. If your program is a subroutine library, you
671
+ may consider it more useful to permit linking proprietary applications with
672
+ the library. If this is what you want to do, use the GNU Lesser General
673
+ Public License instead of this License. But first, please read
674
+ <http://www.gnu.org/philosophy/why-not-lgpl.html>.
README.md CHANGED
@@ -1,3 +1,53 @@
1
- # The `selector` web app
2
 
 
 
 
 
3
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The `selector` Webapp
2
 
3
+ [![This project supports Python 3.7+](https://img.shields.io/badge/Python-3.7+-blue.svg)](https://python.org/downloads)
4
+ [![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)
5
+ [![GitHub Actions CI Tox Status](https://github.com/theochem/Selector/actions/workflows/ci_tox.yml/badge.svg?branch=main)](https://github.com/theochem/Selector/actions/workflows/ci_tox.yml)
6
+ [![codecov](https://codecov.io/gh/theochem/Selector/graph/badge.svg?token=0UJixrJfNJ)](https://codecov.io/gh/theochem/Selector)
7
 
8
+ The `selector` library provides methods for selecting a diverse subset of a (molecular) dataset.
9
+
10
+ 🤗 [Selector on HuggingFace](https://huggingface.co/spaces/QCDevs/selector)
11
+
12
+ Citation
13
+ --------
14
+
15
+ Please use the following citation in any publication using the `selector` library:
16
+
17
+ ```md
18
+ @article{
19
+ }
20
+ ```
21
+
22
+ Running Web Interface Locally Using Docker
23
+ ------------
24
+
25
+ ### Install Docker
26
+ - Visit this [site](https://docs.docker.com/engine/install/) to install Docker Engine
27
+ - Open the installed Docker App once to complete the setup
28
+
29
+ ### Build the Docker Image
30
+ - Clone the repository
31
+ ```bash
32
+ git clone https://github.com/theochem/Selector.git
33
+ ```
34
+
35
+ - Change to the Selector directory
36
+ ```bash
37
+ cd Selector
38
+ ```
39
+
40
+ - Change to the webapp branch
41
+ ```bash
42
+ git checkout webapp
43
+ ```
44
+
45
+ - Build the Docker image
46
+ ```bash
47
+ docker build -t selector-webapp .
48
+ ```
49
+
50
+ - Run the Webapp inside Docker Container
51
+ ```bash
52
+ docker run -p 8501:8501 selector-webapp
53
+ ```
README_hf.md ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: QC-Selector
3
+ emoji: 🐳
4
+ colorFrom: purple
5
+ colorTo: gray
6
+ sdk: docker
7
+ app_port: 8501
8
+ ---
streamlit_app/app.py ADDED
@@ -0,0 +1,99 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import os
25
+
26
+
27
+ # Get the current directory path
28
+ current_dir = os.path.dirname(os.path.abspath(__file__))
29
+
30
+ # Construct the path to the assets directory
31
+ assets_dir = os.path.join(current_dir, "assets")
32
+
33
+ # Set page configuration
34
+ st.set_page_config(
35
+ page_title = "Selector",
36
+ page_icon = os.path.join(assets_dir, "QC-Devs.png"),
37
+ )
38
+
39
+ st.image(os.path.join(assets_dir, "selector_logo.png"))
40
+
41
+ st.write("# Welcome to Selector! 👋")
42
+
43
+ st.sidebar.success("Select an algorithm to get started.")
44
+
45
+ st.info("👈 Select an algorithm from the sidebar to see some examples of what Selector can do!")
46
+
47
+ st.markdown(
48
+ """
49
+ [selector](https://github.com/theochem/Selector) is a free, open-source, and cross-platform
50
+ Python library designed to help you effortlessly identify the most diverse subset of molecules
51
+ from your dataset.
52
+ Please use the following citation in any publication using selector library:
53
+
54
+ **“Selector: A Generic Python Package for Subset Selection”**, Fanwang Meng, Alireza Tehrani,
55
+ Valerii Chuiko, Abigail Broscius, Abdul, Hassan, Maximilian van Zyl, Marco Martínez González,
56
+ Yang, Ramón Alain Miranda-Quintana, Paul W. Ayers, and Farnaz Heidar-Zadeh”
57
+
58
+ The selector source code is hosted on [GitHub](https://github.com/theochem/Selector)
59
+ and is released under the [GNU General Public License v3.0](https://github.com/theochem/Selector/blob/main/LICENSE).
60
+ We welcome any contributions to the selector library in accordance with our Code of Conduct;
61
+ please see our [Contributing Guidelines](https://qcdevs.org/guidelines/qcdevs_code_of_conduct/).
62
+ Please report any issues you encounter while using
63
+ selector library on [GitHub Issues](https://github.com/theochem/Selector/issues).
64
+ For further information and inquiries please contact us at qcdevs@gmail.com.
65
+
66
+ ### Why QC-Selector?
67
+ In the world of chemistry, selecting the right subset of molecules is critical for a wide
68
+ range of applications, including drug discovery, materials science, and molecular optimization.
69
+ QC-Selector offers a cutting-edge solution to streamline this process, empowering researchers,
70
+ scientists, and developers to make smarter decisions faster.
71
+
72
+ ### Key Features
73
+ 1. Import Your Dataset: Simply import your molecule dataset in various file formats, including SDF, SMILES, and InChi, to get started.
74
+
75
+ 2. Define Selection Criteria: Specify the desired level of diversity and other relevant parameters to tailor the subset selection to your unique requirements.
76
+
77
+ 3. Run the Analysis: Let QC-Selector’s powerful algorithms process your dataset and efficiently select the most diverse molecules.
78
+
79
+ 4. Export: Explore the diverse subset and export the results for further analysis and integration into your projects.
80
+ """
81
+ )
82
+
83
+ st.sidebar.title("About QC-Devs")
84
+
85
+ st.sidebar.info("QC-Devs develops various free, open-source, and cross-platform libraries for scientific computing, especially theoretical and computational chemistry. Our goal is to make programming accessible to chemists and promote precepts of sustainable software development. For further information and inquiries please contact us at qcdevs@gmail.com.")
86
+
87
+ # Add icons to the sidebar
88
+ st.sidebar.markdown(
89
+ """
90
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
91
+ <div style="text-align: center;">
92
+ <a href="https://qcdevs.org/" target="_blank"><i class="fa fa-home" style="font-size:24px"></i> WEBSITE</a><br>
93
+ <a href="mailto:qcdevs@gmail.com"><i class="fa fa-envelope" style="font-size:24px"></i> EMAIL</a><br>
94
+ <a href="https://github.com/theochem" target="_blank"><i class="fa fa-github" style="font-size:24px"></i> GITHUB</a><br>
95
+ © 2024 QC-Devs. All rights reserved.
96
+ </div>
97
+ """,
98
+ unsafe_allow_html=True
99
+ )
streamlit_app/assets/QC-Devs.png ADDED
streamlit_app/assets/selector_logo.png ADDED
streamlit_app/features.py ADDED
@@ -0,0 +1,528 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # -*- coding: utf-8 -*-
2
+ # The DiverseSelector library provides a set of tools to select molecule
3
+ # subset with maximum molecular diversity.
4
+ #
5
+ # Copyright (C) 2022 The QC-Devs Community
6
+ #
7
+ # This file is part of DiverseSelector.
8
+ #
9
+ # DiverseSelector is free software; you can redistribute it and/or
10
+ # modify it under the terms of the GNU General Public License
11
+ # as published by the Free Software Foundation; either version 3
12
+ # of the License, or (at your option) any later version.
13
+ #
14
+ # DiverseSelector is distributed in the hope that it will be useful,
15
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
16
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
+ # GNU General Public License for more details.
18
+ #
19
+ # You should have received a copy of the GNU General Public License
20
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
21
+ #
22
+ # --
23
+
24
+ """Feature generation module."""
25
+
26
+ import os
27
+ from pathlib import PurePath
28
+ import sys
29
+ from typing import Union
30
+
31
+ import numpy as np
32
+ import pandas as pd
33
+ from rdkit import Chem
34
+ from rdkit.Chem import AllChem, Descriptors, MACCSkeys, rdMHFPFingerprint, Draw
35
+
36
+ __all__ = [
37
+ "DescriptorGenerator",
38
+ "FingerprintGenerator",
39
+ "feature_reader",
40
+ "aug_features",
41
+ ]
42
+
43
+
44
+ class DescriptorGenerator:
45
+ """Compute molecular features."""
46
+
47
+ def __init__(self,
48
+ mols: list = None):
49
+ """Coinstructor of DescriptorGenerator."""
50
+ self.mols = mols
51
+
52
+ def mordred_desc(self, ignore_3D: bool = False): # noqa: N803
53
+ """Mordred molecular descriptor generation.
54
+
55
+ Parameters
56
+ ----------
57
+ ignore_3D : bool, optional
58
+ Ignore 3D coordinates. The default=False.
59
+
60
+ Returns
61
+ -------
62
+ df_features: PandasDataFrame
63
+ A `pandas.DataFrame` object with compute Mordred descriptors.
64
+
65
+ """
66
+ from mordred import Calculator, descriptors # pylint: disable=C0415
67
+ # if only compute 2D descriptors, set ignore_3D=True
68
+ calc = Calculator(descs=descriptors, ignore_3D=ignore_3D)
69
+ df_features = pd.DataFrame(calc.pandas(self.mols))
70
+
71
+ return df_features
72
+
73
+ @staticmethod
74
+ def padelpy_desc(mol_file: Union[str, PurePath],
75
+ keep_csv: bool = False,
76
+ maxruntime: int = -1,
77
+ waitingjobs: int = -1,
78
+ threads: int = -1,
79
+ d_2d: bool = True,
80
+ d_3d: bool = True,
81
+ config: str = None,
82
+ convert3d: bool = False,
83
+ descriptortypes: str = None,
84
+ detectaromaticity: bool = False,
85
+ fingerprints: bool = False,
86
+ log: bool = False,
87
+ maxcpdperfile: int = 0,
88
+ removesalt: bool = False,
89
+ retain3d: bool = False,
90
+ standardizenitro: bool = False,
91
+ standardizetautomers: bool = False,
92
+ tautomerlist: str = None,
93
+ usefilenameasmolname: bool = False,
94
+ sp_timeout: int = None,
95
+ headless: bool = True): # pylint: disable=R0201
96
+ """PADEL molecular descriptor generation.
97
+
98
+ Parameters
99
+ ----------
100
+ mol_file : str
101
+ Molecule file name.
102
+ keep_csv : bool, optional
103
+ If True, the csv file is kept. Default=False.
104
+ maxruntime : int, optional
105
+ Additional keyword arguments.
106
+ See https://github.com/ecrl/padelpy/blob/master/padelpy/wrapper.py.
107
+
108
+ Returns
109
+ -------
110
+ df_features: PandasDataFrame
111
+ A `pandas.DataFrame` object with compute Mordred descriptors.
112
+
113
+ """
114
+ cwd = os.path.dirname(os.path.abspath(__file__))
115
+ sys.path.append(os.path.join(cwd, "padelpy"))
116
+
117
+ from padelpy import padeldescriptor # pylint: disable=C0415
118
+ # if only compute 2D descriptors,
119
+ # ignore_3D=True
120
+
121
+ csv_fname = (
122
+ str(os.path.basename(mol_file)).split(".", maxsplit=1)[0]
123
+ + "_padel_descriptors.csv"
124
+ )
125
+
126
+ padeldescriptor(
127
+ maxruntime=maxruntime,
128
+ waitingjobs=waitingjobs,
129
+ threads=threads,
130
+ d_2d=d_2d,
131
+ d_3d=d_3d,
132
+ config=config,
133
+ convert3d=convert3d,
134
+ descriptortypes=descriptortypes,
135
+ detectaromaticity=detectaromaticity,
136
+ mol_dir=mol_file,
137
+ d_file=csv_fname,
138
+ fingerprints=fingerprints,
139
+ log=log,
140
+ maxcpdperfile=maxcpdperfile,
141
+ removesalt=removesalt,
142
+ retain3d=retain3d,
143
+ retainorder=True,
144
+ standardizenitro=standardizenitro,
145
+ standardizetautomers=standardizetautomers,
146
+ tautomerlist=tautomerlist,
147
+ usefilenameasmolname=usefilenameasmolname,
148
+ sp_timeout=sp_timeout,
149
+ headless=headless,
150
+ )
151
+
152
+ df_features = pd.read_csv(csv_fname, sep=",", index_col="Name")
153
+
154
+ if not keep_csv:
155
+ os.remove(csv_fname)
156
+
157
+ return df_features
158
+
159
+ def rdkit_desc(self,
160
+ use_fragment: bool = True,
161
+ ipc_avg: bool = True):
162
+ """Generation RDKit molecular descriptors.
163
+
164
+ Parameters
165
+ ----------
166
+ use_fragment : bool, optional
167
+ If True, the return value includes the fragment binary descriptors like "fr_XXX".
168
+ ipc_avg : bool, optional
169
+ If True, the IPC descriptor calculates with avg=True option.
170
+
171
+ Returns
172
+ -------
173
+ df_features: PandasDataFrame
174
+ A `pandas.DataFrame` object with compute Mordred descriptors.
175
+
176
+ """
177
+ # parsing descriptor information
178
+ # parsing descriptor information
179
+ desc_list = []
180
+ descriptor_types = []
181
+ for descriptor, function in Descriptors.descList:
182
+ if use_fragment is False and descriptor.startswith("fr_"):
183
+ continue
184
+ descriptor_types.append(descriptor)
185
+ desc_list.append((descriptor, function))
186
+
187
+ # check initialization
188
+ assert len(descriptor_types) == len(desc_list)
189
+
190
+ arr_features = np.full(shape=(len(self.mols), len(desc_list)),
191
+ fill_value=np.nan)
192
+
193
+ for idx_row, mol in enumerate(self.mols):
194
+ # this part is modified from
195
+ # https://github.com/deepchem/deepchem/blob/master/deepchem/feat/molecule_featurizers/
196
+ # rdkit_descriptors.py#L11-L98
197
+ for idx_col, (desc_name, function) in enumerate(desc_list):
198
+ if desc_name == "Ipc" and ipc_avg:
199
+ feature = function(mol, avg=True)
200
+ else:
201
+ feature = function(mol)
202
+ arr_features[idx_row, idx_col] = feature
203
+
204
+ df_features = pd.DataFrame(arr_features, columns=descriptor_types)
205
+
206
+ return df_features
207
+
208
+ def rdkit_frag_desc(self):
209
+ """Generation of the RDKit fragment features.
210
+
211
+ Returns
212
+ -------
213
+ df_features: PandasDataFrame
214
+ A `pandas.DataFrame` object with compute Mordred descriptors.
215
+
216
+ """
217
+ # http://rdkit.org/docs/source/rdkit.Chem.Fragments.html
218
+ # this implementation is taken from https://github.com/Ryan-Rhys/FlowMO/blob/
219
+ # e221d989914f906501e1ad19cd3629d88eac1785/property_prediction/data_utils.py#L111
220
+ fragments = {d[0]: d[1] for d in Descriptors.descList[115:]}
221
+ frag_features = np.zeros((len(self.mols), len(fragments)))
222
+ for idx, mol in enumerate(self.mols):
223
+ features = [fragments[d](mol) for d in fragments]
224
+ frag_features[idx, :] = features
225
+
226
+ feature_names = [desc[0] for desc in Descriptors.descList[115:]]
227
+ df_features = pd.DataFrame(data=frag_features, columns=feature_names)
228
+
229
+ return df_features
230
+
231
+
232
+ class FingerprintGenerator:
233
+ """Fingerprint generator."""
234
+
235
+ def __init__(self, mols: list) -> None:
236
+ """Fingerprint generator.
237
+
238
+ Parameters
239
+ ----------
240
+ mols : RDKitMol
241
+ Molecule object.
242
+ """
243
+ self.mols = mols
244
+
245
+ # molecule names
246
+ mol_names = [
247
+ Chem.MolToSmiles(mol)
248
+ if mol.GetPropsAsDict().get("_Name") is None
249
+ else mol.GetProp("_Name")
250
+ for mol in mols
251
+ ]
252
+ self.mol_names = mol_names
253
+
254
+ def compute_fingerprint(
255
+ self,
256
+ fp_type: str = "SECFP",
257
+ n_bits: int = 2048,
258
+ radius: int = 3,
259
+ min_radius: int = 1,
260
+ random_seed: int = 12345,
261
+ rings: bool = True,
262
+ isomeric: bool = True,
263
+ kekulize: bool = False,
264
+ ):
265
+ """Compute fingerprints.
266
+
267
+ Parameters
268
+ ----------
269
+ fp_type : str, optional
270
+ Supported fingerprints: SECFP, ECFP, Morgan, RDKitFingerprint and MACCSkeys.
271
+ Default="SECFP".
272
+ n_bits : int, optional
273
+ Number of bits of fingerprint. Default=2048.
274
+ radius : int, optional
275
+ The maximum radius of the substructure that is generated at each atom. Default=3.
276
+ min_radius : int, optional
277
+ The minimum radius that is used to extract n-grams.
278
+ random_seed : int, optional
279
+ The random seed number. Default=12345.
280
+ rings : bool, optional
281
+ Whether the rings (SSSR) are extracted from the molecule and added to the shingling.
282
+ Default=True.
283
+ isomeric : bool, optional
284
+ Whether the SMILES added to the shingling are isomeric. Default=False.
285
+ kekulize : bool, optional
286
+ Whether the SMILES added to the shingling are kekulized. Default=True.
287
+ """
288
+ if fp_type.upper() in [
289
+ "SECFP",
290
+ "ECFP",
291
+ "MORGAN",
292
+ "RDKFINGERPRINT",
293
+ "MACCSKEYS",
294
+ ]:
295
+ fps = [
296
+ self.rdkit_fingerprint_low(
297
+ mol,
298
+ fp_type=fp_type,
299
+ n_bits=n_bits,
300
+ radius=radius,
301
+ min_radius=min_radius,
302
+ random_seed=random_seed,
303
+ rings=rings,
304
+ isomeric=isomeric,
305
+ kekulize=kekulize,
306
+ )
307
+ for mol in self.mols
308
+ ]
309
+ # todo: add support of e3fp
310
+
311
+ # other cases
312
+ else:
313
+ raise ValueError(f"{fp_type} is not an supported fingerprint type.")
314
+
315
+ df_fps = pd.DataFrame(np.array(fps), index=self.mol_names)
316
+
317
+ return df_fps
318
+
319
+ @staticmethod
320
+ def rdkit_fingerprint_low(
321
+ mol,
322
+ fp_type: str = "SECFP",
323
+ n_bits: int = 2048,
324
+ radius: int = 3,
325
+ min_radius: int = 1,
326
+ random_seed: int = 12345,
327
+ rings: bool = True,
328
+ isomeric: bool = False,
329
+ kekulize: bool = False,
330
+ ):
331
+ """
332
+ Generate required molecular fingerprints.
333
+
334
+ Parameters
335
+ ----------
336
+ mols : RDKitMol
337
+ Molecule object.
338
+ fp_type : str, optional
339
+ Supported fingerprints: SECFP, ECFP, Morgan, RDKitFingerprint and MACCSkeys.
340
+ Default="SECFP".
341
+ n_bits : int, optional
342
+ Number of bits of fingerprint. Default=2048.
343
+ radius : int, optional
344
+ The maximum radius of the substructure that is generated at each atom. Default=3.
345
+ min_radius : int, optional
346
+ The minimum radius that is used to extract n-grams.
347
+ random_seed : int, optional
348
+ The random seed number. Default=12345.
349
+ rings : bool, optional
350
+ Whether the rings (SSSR) are extracted from the molecule and added to the shingling.
351
+ Default=True.
352
+ isomeric : bool, optional
353
+ Whether the SMILES added to the shingling are isomeric. Default=False.
354
+ kekulize : bool, optional
355
+ Whether the SMILES added to the shingling are kekulized. Default=True.
356
+
357
+ Returns
358
+ -------
359
+ fp : ExplicitBitVector
360
+ The computed molecular fingerprint.
361
+
362
+ Notes
363
+ -----
364
+ fingerprint types:
365
+ 1. topological fingerprints: RDKFingerprint, Tanimoto, Dice, Cosine, Sokal, Russel,
366
+ Kulczynski, McConnaughey, and Tversky
367
+ 2. MACCS keys:
368
+ 3. Atom pairs and topological torsions
369
+ 4. Morgan fingerprints (circular fingerprints): Morgan, ECFP, FCFP
370
+
371
+ """
372
+ # SECFP: SMILES extended connectivity fingerprint
373
+ # https://jcheminf.biomedcentral.com/articles/10.1186/s13321-018-0321-8
374
+ if fp_type.upper() == "SECFP":
375
+ secfp_encoder = rdMHFPFingerprint.MHFPEncoder(random_seed)
376
+ fp = secfp_encoder.EncodeSECFPMol(
377
+ mol,
378
+ radius=radius,
379
+ rings=rings,
380
+ isomeric=isomeric,
381
+ kekulize=kekulize,
382
+ min_radius=min_radius,
383
+ length=n_bits,
384
+ )
385
+ # ECFP
386
+ # https://github.com/deepchem/deepchem/blob/1a2d2e9ff097fdbf58894d1f91359fe466c65810/deepchem/utils/rdkit_utils.py#L414
387
+ # https://www.rdkit.org/docs/source/rdkit.Chem.rdMolDescriptors.html
388
+ elif fp_type.upper() == "ECFP":
389
+ # radius=3 --> ECFP6
390
+ fp = AllChem.GetMorganFingerprintAsBitVect(
391
+ mol=mol,
392
+ radius=radius,
393
+ nBits=n_bits,
394
+ useChirality=isomeric,
395
+ useFeatures=False,
396
+ )
397
+ elif fp_type.upper() == "MORGAN":
398
+ fp = AllChem.GetMorganFingerprintAsBitVect(
399
+ mol=mol,
400
+ radius=radius,
401
+ nBits=n_bits,
402
+ useChirality=isomeric,
403
+ useFeatures=True,
404
+ )
405
+ # https://www.rdkit.org/docs/source/rdkit.Chem.rdmolops.html#rdkit.Chem.rdmolops.RDKFingerprint
406
+ elif fp_type.upper() == "RDKFINGERPRINT":
407
+ fp = Chem.rdmolops.RDKFingerprint(
408
+ mol=mol,
409
+ minPath=1,
410
+ # maxPath=mol.GetNumBonds(),
411
+ maxPath=10,
412
+ fpSize=n_bits,
413
+ nBitsPerHash=2,
414
+ useHs=True,
415
+ tgtDensity=0,
416
+ minSize=128,
417
+ branchedPaths=True,
418
+ useBondOrder=True,
419
+ )
420
+ # SMARTS-based implementation of the 166 public MACCS keys
421
+ # https://www.rdkit.org/docs/GettingStartedInPython.html#fingerprinting-and-molecular-similarity
422
+ elif fp_type == "MaCCSKeys":
423
+ fp = MACCSkeys.GenMACCSKeys(mol)
424
+ else:
425
+ # todo: add more
426
+ # https://github.com/keiserlab/e3fp
427
+ # https://chemfp.readthedocs.io/en/latest/fp_types.html
428
+ # https://xenonpy.readthedocs.io/en/stable/_modules/xenonpy/descriptor/fingerprint.html
429
+ raise NotImplementedError(f"{fp_type} is not implemented yet.")
430
+
431
+ return fp
432
+
433
+
434
+ def feature_reader(file_name: str,
435
+ sep: str = ",",
436
+ engine: str = "python",
437
+ **kwargs):
438
+ """Load molecule features/descriptors.
439
+
440
+ Parameters
441
+ ----------
442
+ file_name : str
443
+ File name that provides molecular features.
444
+ sep : str, optional
445
+ Separator use for CSV like files. Default=",".
446
+ engine : str, optional
447
+ Engine name used for reading files, where "python" supports regular expression for CSV
448
+ formats, “xlrd” supports old-style Excel files (.xls), “openpyxl” supports newer Excel file
449
+ formats, “odf” supports OpenDocument file formats (.odf, .ods, .odt), “pyxlsb” supports
450
+ binary Excel files. One should note that the dependency should be installed properly to
451
+ make it work. Default="python".
452
+ **kwargs
453
+ Additional keyword arguments passed to
454
+ `pd.read_csv() <https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html>`_
455
+ or `pd.read_excel() <https://pandas.pydata.org/docs/reference/api/pandas.read_excel.html>`_.
456
+
457
+ Returns
458
+ -------
459
+ df : PandasDataFrame
460
+ A `pandas.DataFrame` object with molecular features.
461
+ """
462
+
463
+ # use `str` function to support PosixPath
464
+ if str(file_name).lower().endswith((".csv", ".txt")):
465
+ df = pd.read_csv(file_name, sep=sep, engine=engine, *kwargs)
466
+ elif (
467
+ str(file_name)
468
+ .lower()
469
+ .endswith((".xlsx", ".xls", "xlsb", ".odf", ".ods", ".odt"))
470
+ ):
471
+ df = pd.read_excel(file_name, engine=engine, *kwargs)
472
+
473
+ return df
474
+
475
+
476
+ def aug_features(features,
477
+ target_prop,
478
+ weight: Union[np.ndarray, float, int] = None) -> np.ndarray:
479
+ r"""Augmented features.
480
+
481
+ Parameters
482
+ ----------
483
+ features : np.ndarray or PandasDataFrame
484
+ Molecular features.
485
+ target_prop : np.ndarray or PandasDataFrame
486
+ Target properties.
487
+ weight : np.ndarray, optional
488
+ Weight for each molecule. When weight is not provided (None), the property will be
489
+ directly augmented to the features without repeats. Default=None.
490
+
491
+ Returns
492
+ -------
493
+ aug_features : np.ndarray
494
+ Augmented features matrix.
495
+
496
+ Notes
497
+ -----
498
+ When the property becomes the focus instead of structural diversity, we can just use the
499
+ property matrix as the feature matrix without using fingerprints or molecular descriptors.
500
+
501
+ The augmented feature matrix is a concatenation of the original features matrix and the
502
+ property matrix. When a weight matrix is provided, then the repeat-value for each property to
503
+ be :math:`repeats = \left \lceil weight \times n_{features} \right \rceil`
504
+ where :math:`n_{features}` denotes the number of features (length of the
505
+ fingerprint/descriptors), and the final augmented features matrix is of feature matrix
506
+ augmented by the property matrix for :math:`repeat` times.
507
+
508
+ To achieve sampling with respect to target properties and diversity with respect to a
509
+ fingerprint/feature-vector, you need to append the target properties to the feature vector.
510
+ For each property, specify the :math:`repeats`: the more times you repeat the property
511
+ value the higher its weight.
512
+
513
+ """
514
+ if isinstance(features, pd.DataFrame):
515
+ features = features.to_numpy()
516
+ if isinstance(target_prop, pd.DataFrame):
517
+ target_prop = target_prop.to_numpy()
518
+
519
+ # define the repeat-value for each property
520
+ if weight is not None:
521
+ repeats = np.ceil(np.multiply(weight, features.shape[1]))
522
+ else:
523
+ repeats = 1
524
+
525
+ features_new = np.hstack((features,
526
+ np.repeat(target_prop, repeats=repeats, axis=1)))
527
+
528
+ return features_new
streamlit_app/pages/Converter.py ADDED
@@ -0,0 +1,112 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import streamlit as st
2
+ from rdkit import Chem
3
+ from rdkit.Chem import Draw
4
+ import tempfile
5
+ import os
6
+ import sys
7
+
8
+
9
+ # Add the streamlit_app directory to the Python path
10
+ current_dir = os.path.dirname(os.path.abspath(__file__))
11
+ module_path = os.path.abspath(os.path.join(current_dir, '..', '..'))
12
+ sys.path.append(module_path)
13
+ parent_dir = os.path.join(current_dir, "..")
14
+ sys.path.append(parent_dir)
15
+
16
+ from utils import *
17
+ from streamlit_app.features import DescriptorGenerator, FingerprintGenerator
18
+
19
+
20
+ # Set up the page configuration
21
+ set_page_config(
22
+ page_title = "Chem Converter",
23
+ page_icon = os.path.join(parent_dir, "assets", "QC-Devs.png")
24
+ )
25
+
26
+ st.title("Chemical File Converter")
27
+
28
+ # Description of the page
29
+ st.markdown("""
30
+ This page allows you to upload raw chemical file formats such as SMILES or SDF,
31
+ and convert them into chemical matrices that can be used as input for selector's various algorithms.
32
+ """)
33
+
34
+ # File uploader for chemical file
35
+ chemical_file = st.file_uploader("Upload a chemical file (e.g., SMILES, SDF, or TXT)",
36
+ type = ["txt", "smi", "sdf"])
37
+
38
+ if chemical_file:
39
+ # User selects the file format
40
+ file_format = st.selectbox(
41
+ "Select the format of the provided file",
42
+ options = ["", "SMILES", "SDF"]
43
+ )
44
+
45
+ if file_format:
46
+ molecules = []
47
+ temp_sdf_path = None
48
+
49
+ # Process the chemical file based on user selection
50
+ if file_format == "SMILES":
51
+ smiles_list = chemical_file.read().decode("utf-8").splitlines()
52
+ molecules = [Chem.MolFromSmiles(smiles) for smiles in smiles_list]
53
+ elif file_format == "SDF":
54
+ # Create a temporary file to save the uploaded SDF content
55
+ with tempfile.NamedTemporaryFile(delete = False, suffix = ".sdf") as temp_sdf:
56
+ temp_sdf.write(chemical_file.read())
57
+ temp_sdf_path = temp_sdf.name
58
+
59
+ # Use RDKit's SDMolSupplier to read molecules from the SDF file
60
+ supplier = Chem.SDMolSupplier(temp_sdf_path)
61
+ molecules = [mol for mol in supplier if mol is not None]
62
+
63
+ # Explicitly close the supplier to release the file
64
+ del supplier
65
+
66
+ # Check for valid molecules
67
+ valid_molecules = [mol for mol in molecules if mol is not None]
68
+
69
+ if not valid_molecules:
70
+ st.error("No valid molecules found in the uploaded file.")
71
+ else:
72
+ st.success(f"Successfully loaded {len(valid_molecules)} valid molecules.")
73
+
74
+ # Display the molecules
75
+ img = Draw.MolsToImage(valid_molecules)
76
+ st.image(img, caption = "Molecules in the file")
77
+
78
+ # Choose the type of matrix to generate
79
+ matrix_type = st.selectbox("Choose matrix type", ["Descriptors", "Fingerprints"])
80
+
81
+ if matrix_type == "Descriptors":
82
+ # Allow the user to choose the type of descriptors to generate
83
+ use_fragment = st.checkbox("Whether return value includes the fragment binary descriptors", value = True)
84
+ ipc_avg = st.checkbox("Whether IPC descriptor calculates with avg", value = True)
85
+
86
+ descriptor_generator = DescriptorGenerator(valid_molecules)
87
+ matrix = descriptor_generator.rdkit_desc(use_fragment, ipc_avg)
88
+ elif matrix_type == "Fingerprints":
89
+ # Allow user to choose the type of fingerprint to generate
90
+ fp_type = st.selectbox("Select Fingerprint Type", options=["SECFP", "ECFP", "Morgan"])
91
+ n_bits = st.number_input("Number of bits for the fingerprint", min_value = 1, value = 2048)
92
+ radius = st.number_input("The maximum radius of the substructure that is generated at each atom", min_value = 1, value = 3)
93
+ min_radius = st.number_input("The minimum radius that is used to extract n-grams", min_value = 1, value = 3)
94
+ random_seed = st.number_input("Random seed for fingerprint generation", min_value = 0, value = 12345)
95
+ rings = st.checkbox("Whether the rings (SSSR) are extracted from the molecule and added to the shingling", value = True)
96
+ isomeric = st.checkbox("Whether the SMILES added to the shingling are isomeric", value = True)
97
+ kekulize = st.checkbox("Whether the SMILES added to the shingling are kekulized", value = False)
98
+
99
+ fp_generator = FingerprintGenerator(valid_molecules)
100
+ matrix = fp_generator.compute_fingerprint(fp_type = fp_type)
101
+
102
+ st.write("Generated Chemical Matrix:")
103
+ st.dataframe(matrix)
104
+
105
+ # Option to download the matrix as CSV
106
+ csv_data = matrix.to_csv().encode('utf-8')
107
+ st.download_button("Download Chemical Matrix as CSV", data = csv_data,
108
+ file_name = "chemical_matrix.csv", mime = "text/csv")
109
+
110
+ # Clean up the temporary file after RDKit is done with it
111
+ if temp_sdf_path and os.path.exists(temp_sdf_path):
112
+ os.remove(temp_sdf_path)
streamlit_app/pages/DISE.py ADDED
@@ -0,0 +1,112 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import sys
25
+ import os
26
+
27
+ from selector.methods.distance import DISE
28
+
29
+ # Add the streamlit_app directory to the Python path
30
+ current_dir = os.path.dirname(os.path.abspath(__file__))
31
+ parent_dir = os.path.join(current_dir, "..")
32
+ sys.path.append(parent_dir)
33
+
34
+ from utils import *
35
+
36
+ # Set page configuration
37
+ st.set_page_config(
38
+ page_title = "DISE",
39
+ page_icon = os.path.join(parent_dir, "assets" , "QC-Devs.png"),
40
+ )
41
+
42
+ st.title("Directed Sphere Exclusion (DISE)")
43
+
44
+
45
+ description = """
46
+ In a nutshell, this algorithm iteratively excludes any sample within a given radius from
47
+ any already selected sample. The radius of the exclusion sphere is an adjustable parameter.
48
+ Compared to Sphere Exclusion algorithm, the Directed Sphere Exclusion algorithm achieves a
49
+ more evenly distributed subset selection by abandoning the random selection approach and
50
+ instead imposing a directed selection.
51
+
52
+ Reference sample is chosen based on the `ref_index`, which is excluded from the selected
53
+ subset. All samples are sorted (ascending order) based on their Minkowski p-norm distance
54
+ from the reference sample. Looping through sorted samples, the sample is selected if it is
55
+ not already excluded. If selected, all its neighboring samples within a sphere of radius r
56
+ (i.e., exclusion sphere) are excluded from being selected. When the selected number of points
57
+ is greater than specified subset `size`, the selection process terminates. The `r0` is used
58
+ as the initial radius of exclusion sphere, however, it is optimized to select the desired
59
+ number of samples.
60
+ """
61
+
62
+ references = "Gobbi, A., and Lee, M.-L. (2002). DISE: directed sphere exclusion."\
63
+ "Journal of Chemical Information and Computer Sciences,"\
64
+ "43(1), 317–323. https://doi.org/10.1021/ci025554v"
65
+
66
+ display_sidebar_info("Directed Sphere Exclusion (DISE)", description, references)
67
+
68
+ # File uploader for feature matrix or distance matrix (required)
69
+ matrix_file = st.file_uploader("Upload a feature matrix or distance matrix (required)",
70
+ type=["csv", "xlsx", "npz", "npy"], key="matrix_file", on_change=clear_results)
71
+
72
+ # Clear selected indices if a new matrix file is uploaded
73
+ if matrix_file is None:
74
+ clear_results()
75
+ # Load data from matrix file
76
+ else:
77
+ matrix = load_matrix(matrix_file)
78
+ num_points = st.number_input("Number of points to select", min_value = 1, step = 1,
79
+ key = "num_points", on_change=clear_results)
80
+ label_file = st.file_uploader("Upload a cluster label list (optional)", type = ["csv", "xlsx"],
81
+ key = "label_file", on_change=clear_results)
82
+ labels = load_labels(label_file) if label_file else None
83
+
84
+ # Parameters for Directed Sphere Exclusion
85
+ st.info("The parameters below are optional. If not specified, default values will be used.")
86
+
87
+ r0 = st.number_input("Initial guess for radius of exclusion sphere (r0)", value=None, step=0.1,
88
+ on_change=clear_results)
89
+ ref_index = st.number_input("Reference index (ref_index)", value=0, step=1, on_change=clear_results)
90
+ tol = st.number_input("Percentage tolerance of sample size error (tol)", value=0.05, step=0.05,
91
+ on_change=clear_results)
92
+ n_iter = st.number_input("Number of iterations for optimizing the radius of exclusion sphere (n_iter)",
93
+ value=10, step=10, on_change=clear_results)
94
+ p = st.number_input("Minkowski p-norm distance (p)", value=2.0, step=1.0, on_change=clear_results)
95
+ eps = st.number_input("Approximate nearest neighbor search parameter (eps)", value=0.0, step=0.1,
96
+ on_change=clear_results)
97
+
98
+ if st.button("Run DISE Algorithm"):
99
+ selector = DISE(r0=r0, ref_index=ref_index, tol=tol, n_iter=n_iter, p=p, eps=eps)
100
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
101
+ st.session_state['selector'] = selector
102
+ st.session_state['selected_ids'] = selected_ids
103
+
104
+ # Check if the selected indices are stored in the session state
105
+ if 'selected_ids' in st.session_state and matrix_file is not None:
106
+ selected_ids = st.session_state['selected_ids']
107
+ st.write("Selected indices:", selected_ids)
108
+
109
+ if 'selector' in st.session_state:
110
+ st.write("Radius of the exclusion sphere:", st.session_state['selector'].r)
111
+
112
+ export_results(selected_ids)
streamlit_app/pages/GridPartition.py ADDED
@@ -0,0 +1,98 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import sys
25
+ import os
26
+
27
+ from selector.methods.partition import GridPartition
28
+
29
+ # Add the streamlit_app directory to the Python path
30
+ current_dir = os.path.dirname(os.path.abspath(__file__))
31
+ parent_dir = os.path.join(current_dir, "..")
32
+ sys.path.append(parent_dir)
33
+
34
+ from utils import *
35
+
36
+ # Set page configuration
37
+ st.set_page_config(
38
+ page_title = "GridPartition",
39
+ page_icon = os.path.join(parent_dir, "assets" , "QC-Devs.png"),
40
+ )
41
+
42
+ st.title("Grid Partitioning Method")
43
+
44
+
45
+ description = """
46
+ Given the number of bins along each axis, samples are partitioned using various methods:
47
+
48
+ 1. The equisized_independent partitions the feature space into bins of equal size along each dimension.
49
+
50
+ 2. The equisized_dependent partitions the space where the bins can have different length in each dimension. I.e., the `l-`th dimension bins depend on the previous dimensions. So, the order of features affects the outcome.
51
+
52
+ 3. The equifrequent_independent divides the space into bins with approximately equal number of sample points in each bin.
53
+
54
+ 4. The equifrequent_dependent is similar to equisized_dependent where the partition in each dimension will depend on the previous dimensions.
55
+ """
56
+
57
+ references = "[1] Bayley, Martin J., and Peter Willett. “Binning schemes for partition-based compound selection.” Journal of Molecular Graphics and Modelling 17.1 (1999): 10-18."
58
+
59
+ display_sidebar_info("Grid Partitioning Method", description, references)
60
+
61
+ # File uploader for feature matrix or distance matrix (required)
62
+ matrix_file = st.file_uploader("Upload a feature matrix or distance matrix (required)",
63
+ type=["csv", "xlsx", "npz", "npy"], key="matrix_file", on_change=clear_results)
64
+
65
+ # Clear selected indices if a new matrix file is uploaded
66
+ if matrix_file is None:
67
+ clear_results()
68
+
69
+ # Load data from matrix file
70
+ else:
71
+ matrix = load_matrix(matrix_file)
72
+ num_points = st.number_input("Number of points to select", min_value = 1, step = 1,
73
+ key = "num_points", on_change=clear_results)
74
+ label_file = st.file_uploader("Upload a cluster label list (optional)", type = ["csv", "xlsx"],
75
+ key = "label_file", on_change=clear_results)
76
+ labels = load_labels(label_file) if label_file else None
77
+
78
+ numb_bins_axis = st.number_input("Number of bins to partition each axis into (numb_bins_axis)", value = 1, step = 1)
79
+
80
+ # Parameters for Directed Sphere Exclusion
81
+ st.info("The parameters below are optional. If not specified, default values will be used.")
82
+
83
+ grid_method = st.selectbox("Method used to partition the sample points into bins. (grid_method)", ["equisized_independent",
84
+ "equisized_dependent", "equifrequent_independent", "equifrequent_dependent"], on_change=clear_results)
85
+
86
+ random_seed = st.number_input("Seed for random selection of sample points from each bin. (random_seed)", value=42, step=1, on_change=clear_results)
87
+
88
+ if st.button("Run GridPartition Algorithm"):
89
+ selector = GridPartition(numb_bins_axis, grid_method, random_seed)
90
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
91
+ st.session_state['selected_ids'] = selected_ids
92
+
93
+ # Check if the selected indices are stored in the session state
94
+ if 'selected_ids' in st.session_state and matrix_file is not None:
95
+ selected_ids = st.session_state['selected_ids']
96
+ st.write("Selected indices:", selected_ids)
97
+
98
+ export_results(selected_ids)
streamlit_app/pages/MaxMin.py ADDED
@@ -0,0 +1,110 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import os
25
+ import sys
26
+
27
+ from sklearn.metrics import pairwise_distances
28
+ from selector.methods.distance import MaxMin
29
+
30
+ # Add the streamlit_app directory to the Python path
31
+ current_dir = os.path.dirname(os.path.abspath(__file__))
32
+ parent_dir = os.path.join(current_dir, "..")
33
+ sys.path.append(parent_dir)
34
+
35
+ from utils import *
36
+
37
+ # Set page configuration
38
+ st.set_page_config(
39
+ page_title = "MaxMin",
40
+ page_icon = os.path.join(parent_dir, "assets" , "QC-Devs.png"),
41
+ )
42
+
43
+ st.title("Brute Strength - MaxMin")
44
+
45
+ description = """
46
+ MaxMin is possibly the most widely used method for dissimilarity-based
47
+ compound selection. When presented with a dataset of samples, the
48
+ initial point is chosen as the dataset's medoid center. Next, the second
49
+ point is chosen to be that which is furthest from this initial point.
50
+ Subsequently, all following points are selected via the following
51
+ logic:
52
+
53
+ 1. Find the minimum distance from every point to the already-selected ones.
54
+ 2. Select the point which has the maximum distance among those calculated
55
+ in the previous step.
56
+
57
+ In the current implementation, this method requires or computes the full pairwise-distance
58
+ matrix, so it is not recommended for large datasets.
59
+ """
60
+
61
+
62
+ references = "[1] Ashton, Mark, et al., Identification of diverse database subsets using "\
63
+ "property‐based and fragment‐based molecular descriptions, "\
64
+ "Quantitative Structure‐Activity Relationships 21.6 (2002): 598-604."
65
+
66
+ display_sidebar_info("Brute Strength - MaxMin", description, references)
67
+
68
+ # File uploader for feature matrix or distance matrix (required)
69
+ matrix_file = st.file_uploader("Upload a feature matrix or distance matrix (required)",
70
+ type=["csv", "xlsx", "npz", "npy"], key="matrix_file", on_change=clear_results)
71
+
72
+ # Clear selected indices if a new matrix file is uploaded
73
+ if matrix_file is None:
74
+ st.session_state.pop("selected_ids", None)
75
+ # Load data from matrix file
76
+ else:
77
+ matrix = load_matrix(matrix_file)
78
+ num_points = st.number_input("Number of points to select", min_value = 1, step = 1,
79
+ key = "num_points", on_change=clear_results)
80
+ label_file = st.file_uploader("Upload a cluster label list (optional)", type = ["csv", "xlsx"],
81
+ key = "label_file", on_change=clear_results)
82
+ labels = load_labels(label_file) if label_file else None
83
+
84
+ distance_metric = st.selectbox("Select distance metric (optional)",
85
+ [None, "euclidean", "manhattan", "cosine"],
86
+ key = "distance_metric", on_change=clear_results)
87
+
88
+ if distance_metric:
89
+ fun_dist = lambda x: pairwise_distances(x, metric = distance_metric)
90
+ else:
91
+ fun_dist = None
92
+
93
+ if st.button("Run MaxMin Algorithm"):
94
+ if fun_dist:
95
+ selector = MaxMin(fun_dist)
96
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
97
+ else:
98
+ selector = MaxMin()
99
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
100
+
101
+ st.session_state['selector'] = selector
102
+ st.session_state['selected_ids'] = selected_ids
103
+
104
+
105
+ # Check if the selected indices are stored in the session state
106
+ if 'selected_ids' in st.session_state and matrix_file is not None:
107
+ selected_ids = st.session_state['selected_ids']
108
+ st.write("Selected indices:", selected_ids)
109
+
110
+ export_results(selected_ids)
streamlit_app/pages/MaxSum.py ADDED
@@ -0,0 +1,109 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import os
25
+ import sys
26
+
27
+ from sklearn.metrics import pairwise_distances
28
+
29
+ from selector.methods.distance import MaxSum
30
+
31
+ # Add the streamlit_app directory to the Python path
32
+ current_dir = os.path.dirname(os.path.abspath(__file__))
33
+ parent_dir = os.path.join(current_dir, "..")
34
+ sys.path.append(parent_dir)
35
+
36
+
37
+ from utils import *
38
+
39
+ # Set page configuration
40
+ st.set_page_config(
41
+ page_title = "MaxSum",
42
+ page_icon = os.path.join(parent_dir, "assets" , "QC-Devs.png"),
43
+ )
44
+
45
+ st.title("Brute Strength - MaxSum")
46
+
47
+ description = """
48
+ Whereas the goal of the MaxMin algorithm is to maximize the minimum distance between any pair
49
+ of distinct elements in the selected subset of a dataset, the MaxSum algorithm aims to maximize
50
+ the sum of distances between all pairs of elements in the selected subset. When presented with
51
+ a dataset of samples, the initial point is chosen as the dataset’s medoid center. Next,
52
+ the second point is chosen to be that which is furthest from this initial point.
53
+ Subsequently, all following points are selected via the following logic:
54
+
55
+ 1. Determine the sum of distances from every point to the already-selected ones.
56
+ 2. Select the point which has the maximum sum of distances among those calculated in the previous step.
57
+
58
+ In the current implementation, this method requires or computes the full pairwise-distance
59
+ matrix, so it is not recommended for large datasets.
60
+ """
61
+
62
+
63
+ references = "[1] Borodin, Allan, Hyun Chul Lee, and Yuli Ye, Max-sum diversification, "\
64
+ "monotone submodular functions and dynamic updates, Proceedings of the 31st ACM "\
65
+ "SIGMOD-SIGACT-SIGAI symposium on Principles of Database Systems. 2012."
66
+
67
+ display_sidebar_info("Brute Strength - MaxSum", description, references)
68
+
69
+ # File uploader for feature matrix or distance matrix (required)
70
+ matrix_file = st.file_uploader("Upload a feature matrix or distance matrix (required)",
71
+ type=["csv", "xlsx", "npz", "npy"], key="matrix_file", on_change=clear_results)
72
+
73
+ # Clear selected indices if a new matrix file is uploaded
74
+ if matrix_file is None:
75
+ st.session_state.pop("selected_ids", None)
76
+
77
+ # Load data from matrix file
78
+ else:
79
+ matrix = load_matrix(matrix_file)
80
+ num_points = st.number_input("Number of points to select", min_value = 1, step = 1,
81
+ key = "num_points", on_change=clear_results)
82
+ label_file = st.file_uploader("Upload a cluster label list (optional)", type = ["csv", "xlsx"],
83
+ key = "label_file", on_change=clear_results)
84
+ labels = load_labels(label_file) if label_file else None
85
+
86
+ distance_metric = st.selectbox("Select distance metric (optional)",
87
+ [None, "euclidean", "manhattan", "cosine"],
88
+ key = "distance_metric", on_change=clear_results)
89
+
90
+ if distance_metric:
91
+ fun_dist = lambda x: pairwise_distances(x, metric = distance_metric)
92
+ else:
93
+ fun_dist = None
94
+
95
+ if st.button("Run MaxSum Algorithm"):
96
+ if fun_dist:
97
+ selector = MaxSum(fun_dist)
98
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
99
+ else:
100
+ selector = MaxSum()
101
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
102
+
103
+
104
+ # Check if the selected indices are stored in the session state
105
+ if 'selected_ids' in st.session_state and matrix_file is not None:
106
+ selected_ids = st.session_state['selected_ids']
107
+ st.write("Selected indices:", selected_ids)
108
+
109
+ export_results(selected_ids)
streamlit_app/pages/Medoid.py ADDED
@@ -0,0 +1,95 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import sys
25
+ import os
26
+
27
+ import scipy
28
+ from selector.methods.partition import Medoid
29
+
30
+ # Add the streamlit_app directory to the Python path
31
+ current_dir = os.path.dirname(os.path.abspath(__file__))
32
+ parent_dir = os.path.join(current_dir, "..")
33
+ sys.path.append(parent_dir)
34
+
35
+ from utils import *
36
+
37
+ # Set page configuration
38
+ st.set_page_config(
39
+ page_title = "Medoid",
40
+ page_icon = os.path.join(parent_dir, "assets" , "QC-Devs.png"),
41
+ )
42
+
43
+ st.title("Medoid Method")
44
+
45
+
46
+ description = """
47
+ Points are initially used to construct a KDTree. Eucleidean distances are used for this
48
+ algorithm. The first point selected is based on the starting_idx provided and becomes the first
49
+ query point. An approximation of the furthest point to the query point is found using
50
+ find_furthest_neighbor and is selected. find_nearest_neighbor is then done to eliminate close
51
+ neighbors to the new selected point. Medoid is then calculated from previously selected points
52
+ and is used as the new query point for find_furthest_neighbor, repeating the process. Terminates
53
+ upon selecting requested number of points or if all available points exhausted.
54
+ """
55
+
56
+ references = "Adapted from: https://en.wikipedia.org/wiki/K-d_tree#Construction"
57
+
58
+ display_sidebar_info("Medoid Method", description, references)
59
+
60
+ # File uploader for feature matrix or distance matrix (required)
61
+ matrix_file = st.file_uploader("Upload a feature matrix or distance matrix (required)",
62
+ type=["csv", "xlsx", "npz", "npy"], key="matrix_file", on_change=clear_results)
63
+
64
+ # Clear selected indices if a new matrix file is uploaded
65
+ if matrix_file is None:
66
+ clear_results()
67
+
68
+ # Load data from matrix file
69
+ else:
70
+ matrix = load_matrix(matrix_file)
71
+ num_points = st.number_input("Number of points to select", min_value = 1, step = 1,
72
+ key = "num_points", on_change=clear_results)
73
+ label_file = st.file_uploader("Upload a cluster label list (optional)", type = ["csv", "xlsx"],
74
+ key = "label_file", on_change=clear_results)
75
+ labels = load_labels(label_file) if label_file else None
76
+
77
+ # Parameters for Medoid
78
+ st.info("The parameters below are optional. If not specified, default values will be used.")
79
+
80
+ start_id = st.number_input("Index for the first point to be selected. (start_id)", value = 0, step = 1, on_change=clear_results)
81
+
82
+ scaling = st.number_input("Percent of average maximum distance to use when eliminating the closest points. (scaling)",
83
+ value=10.0, step=1.0, on_change=clear_results)
84
+
85
+ if st.button("Run Medoid Algorithm"):
86
+ selector = Medoid(start_id=start_id, func_distance = lambda x, y: scipy.spatial.minkowski_distance(x, y) ** 2, scaling=scaling)
87
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
88
+ st.session_state['selected_ids'] = selected_ids
89
+
90
+ # Check if the selected indices are stored in the session state
91
+ if 'selected_ids' in st.session_state and matrix_file is not None:
92
+ selected_ids = st.session_state['selected_ids']
93
+ st.write("Selected indices:", selected_ids)
94
+
95
+ export_results(selected_ids)
streamlit_app/pages/OptiSim.py ADDED
@@ -0,0 +1,105 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import sys
25
+ import os
26
+
27
+ from selector.methods.distance import OptiSim
28
+
29
+ # Add the streamlit_app directory to the Python path
30
+ current_dir = os.path.dirname(os.path.abspath(__file__))
31
+ parent_dir = os.path.join(current_dir, "..")
32
+ sys.path.append(parent_dir)
33
+
34
+ from utils import *
35
+
36
+ # Set page configuration
37
+ st.set_page_config(
38
+ page_title = "OptiSim",
39
+ page_icon = os.path.join(parent_dir, "assets" , "QC-Devs.png"),
40
+ )
41
+
42
+ st.title("Adapted Optimizable K-Dissimilarity Selection (OptiSim)")
43
+
44
+
45
+ description = """
46
+ The OptiSim algorithm selects samples from a dataset by first choosing the medoid center as the
47
+ initial point. Next, points are randomly chosen and added to a subsample if they exist
48
+ outside of radius r from all previously selected points (otherwise, they are discarded). Once k
49
+ number of points have been added to the subsample, the point with the greatest minimum distance
50
+ to the previously selected points is chosen. Then, the subsample is cleared and the process is
51
+ repeated.
52
+ """
53
+
54
+ references = "[1] J. Chem. Inf. Comput. Sci. 1997, 37, 6, 1181–1188. https://doi.org/10.1021/ci970282v"
55
+
56
+ display_sidebar_info("Adapted Optimizable K-Dissimilarity Selection (OptiSim)", description, references)
57
+
58
+ # File uploader for feature matrix or distance matrix (required)
59
+ matrix_file = st.file_uploader("Upload a feature matrix or distance matrix (required)",
60
+ type=["csv", "xlsx", "npz", "npy"], key="matrix_file", on_change=clear_results)
61
+
62
+ # Clear selected indices if a new matrix file is uploaded
63
+ if matrix_file is None:
64
+ clear_results()
65
+
66
+ # Load data from matrix file
67
+ else:
68
+ matrix = load_matrix(matrix_file)
69
+ num_points = st.number_input("Number of points to select", min_value = 1, step = 1,
70
+ key = "num_points", on_change=clear_results)
71
+ label_file = st.file_uploader("Upload a cluster label list (optional)", type = ["csv", "xlsx"],
72
+ key = "label_file", on_change=clear_results)
73
+ labels = load_labels(label_file) if label_file else None
74
+
75
+ # Parameters for Directed Sphere Exclusion
76
+ st.info("The parameters below are optional. If not specified, default values will be used.")
77
+
78
+ r0 = st.number_input("Initial guess of radius for OptiSim algorithm (r0)", value=None, step=0.1,
79
+ on_change=clear_results)
80
+ ref_index = st.number_input("Index for the sample to start selection from (ref_index)", value=0, step=1, on_change=clear_results)
81
+ k = st.number_input("Amount of points to add to subsample (k)", value=10, step=1,
82
+ on_change=clear_results)
83
+ tol = st.number_input("Percentage error of number of samples selected (tol)", value=0.01, step=0.01, on_change=clear_results)
84
+ n_iter = st.number_input("Number of iterations to execute when optimizing the size of exclusion radius. (n_iter)",
85
+ value=10, step=1, on_change=clear_results)
86
+ p = st.number_input("Minkowski p-norm distance (p)", value=2.0, step=1.0, on_change=clear_results)
87
+ eps = st.number_input("Approximate nearest neighbor search parameter (eps)", value=0.0, step=0.1,
88
+ on_change=clear_results)
89
+ random_seed = st.number_input("Seed for random selection of points be evaluated. (random_seed)", value=42, step=1, on_change=clear_results)
90
+
91
+ if st.button("Run OptiSim Algorithm"):
92
+ selector = OptiSim(r0=r0, ref_index=ref_index, k=k, tol=tol, n_iter=n_iter, eps=eps, p=p, random_seed=random_seed)
93
+ selected_ids = run_algorithm(selector, matrix, num_points, labels)
94
+ st.session_state['selector'] = selector
95
+ st.session_state['selected_ids'] = selected_ids
96
+
97
+ # Check if the selected indices are stored in the session state
98
+ if 'selected_ids' in st.session_state and matrix_file is not None:
99
+ selected_ids = st.session_state['selected_ids']
100
+ st.write("Selected indices:", selected_ids)
101
+
102
+ if 'selector' in st.session_state:
103
+ st.write("Radius of the exclusion sphere:", st.session_state['selector'].r)
104
+
105
+ export_results(selected_ids)
streamlit_app/utils.py ADDED
@@ -0,0 +1,148 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Selector library provides a set of tools for selecting a
2
+ # subset of the dataset and computing diversity.
3
+ #
4
+ # Copyright (C) 2023 The QC-Devs Community
5
+ #
6
+ # This file is part of Selector.
7
+ #
8
+ # Selector is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU General Public License
10
+ # as published by the Free Software Foundation; either version 3
11
+ # of the License, or (at your option) any later version.
12
+ #
13
+ # Selector is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
+ # GNU General Public License for more details.
17
+ #
18
+ # You should have received a copy of the GNU General Public License
19
+ # along with this program; if not, see <http://www.gnu.org/licenses/>
20
+ #
21
+ # --
22
+
23
+ import streamlit as st
24
+ import numpy as np
25
+ import pandas as pd
26
+ import json
27
+ import os
28
+
29
+ from sklearn.metrics import pairwise_distances
30
+
31
+ def set_page_config(page_title, page_icon):
32
+ current_dir = os.path.dirname(os.path.abspath(__file__))
33
+ assets_dir = os.path.join(current_dir, "..", "assets")
34
+
35
+ st.set_page_config(
36
+ page_title=page_title,
37
+ page_icon=os.path.join(assets_dir, page_icon)
38
+ )
39
+
40
+ def display_sidebar_info(title, description, references):
41
+ st.sidebar.header(title)
42
+ st.sidebar.info(description)
43
+ st.sidebar.title("References")
44
+ st.sidebar.info(references)
45
+
46
+ # Load data from matrix file
47
+ def load_matrix(matrix_file):
48
+ try:
49
+ header_option = None
50
+ if matrix_file.name.endswith(".csv") or matrix_file.name.endswith(".xlsx"):
51
+ header_option = st.checkbox("Does the file have a header?", key="header_option",
52
+ on_change = clear_results())
53
+ st.warning("Warning: This will affect the final output if not specified correctly.")
54
+
55
+ if matrix_file.name.endswith(".csv") or matrix_file.name.endswith(".xlsx"):
56
+ if header_option:
57
+ # Load the matrix with header
58
+ matrix = pd.read_csv(matrix_file)
59
+ else:
60
+ # Load the matrix without header
61
+ matrix = pd.read_csv(matrix_file, header=None)
62
+ st.write("Matrix shape:", matrix.shape)
63
+ st.write(matrix.values)
64
+
65
+
66
+ elif matrix_file.name.endswith(".npz"):
67
+ matrix_data = np.load(matrix_file)
68
+ array_names = matrix_data.files # Select the array in the .npz file
69
+ selected_array = st.selectbox("Select the array to use", array_names)
70
+ matrix = matrix_data[selected_array]
71
+ st.write("Matrix shape:", matrix.shape)
72
+ st.write(matrix)
73
+ elif matrix_file.name.endswith(".npy"):
74
+ matrix = np.load(matrix_file)
75
+ st.write("Matrix shape:", matrix.shape)
76
+ st.write(matrix)
77
+ return matrix
78
+ except Exception as e:
79
+ st.error(f'An error occurred while loading matrix file: {e}')
80
+ return None
81
+
82
+ def load_labels(label_file):
83
+ try:
84
+ label_header_option = None
85
+ if label_file.name.endswith(".csv") or label_file.name.endswith(".xlsx"):
86
+ label_header_option = st.checkbox("Does the file have a header?", key="label_header_option",
87
+ on_change = clear_results())
88
+ st.warning("Warning: This will affect the final output if not specified correctly.")
89
+
90
+ if label_file.name.endswith(".csv") or label_file.name.endswith(".xlsx"):
91
+ if label_header_option:
92
+ labels = pd.read_csv(label_file).values.flatten()
93
+ else:
94
+ labels = pd.read_csv(label_file, header=None).values.flatten()
95
+ st.write("Cluster labels shape:", labels.shape)
96
+ st.write(labels)
97
+ return labels
98
+ except Exception as e:
99
+ st.error(f'An error occurred while loading cluster label file: {e}')
100
+ return None
101
+
102
+ def run_algorithm(selector, matrix, num_points, labels):
103
+ try:
104
+ # Separate the non-numeric first column (element names) and the numeric data
105
+ element_names = matrix.iloc[:, 0].values # Assuming the first column contains the names
106
+ numeric_matrix = matrix.select_dtypes(include=[np.number]).values
107
+
108
+ if labels is not None:
109
+ selected_ids = selector.select(numeric_matrix, size = num_points, labels = labels)
110
+ else:
111
+ selected_ids = selector.select(numeric_matrix, size = num_points)
112
+
113
+ selected_ids = [(element_names[i], i) for i in selected_ids]
114
+ st.session_state['selected_ids'] = selected_ids
115
+ return selected_ids
116
+ except ValueError as ve:
117
+ st.error(f"An error occurred while running the algorithm: {ve}")
118
+ except Exception as e:
119
+ st.error(f"An error occurred while running the algorithm: {e}")
120
+ return None
121
+
122
+ def export_results(selected_ids):
123
+ export_format = st.selectbox("Select export format", ["CSV", "JSON"], key="export_format")
124
+
125
+ if export_format == "CSV":
126
+ csv_data = pd.DataFrame(selected_ids, columns=["Element", "Index"])
127
+ csv = csv_data.to_csv(index=False).encode('utf-8')
128
+ st.download_button(
129
+ label="Download as CSV",
130
+ data=csv,
131
+ file_name='selected_indices.csv',
132
+ mime='text/csv',
133
+ )
134
+ else:
135
+ json_data = json.dumps([{"Element": elem, "Index": i} for i, elem in selected_ids])
136
+ st.download_button(
137
+ label="Download as JSON",
138
+ data=json_data,
139
+ file_name='selected_indices.json',
140
+ mime='application/json',
141
+ )
142
+
143
+ # Function to clear selected indices from session state
144
+ def clear_results():
145
+ if 'selected_ids' in st.session_state:
146
+ del st.session_state['selected_ids']
147
+ if 'selector' in st.session_state:
148
+ del st.session_state['selector']