This project is a web-based application for storing, searching, and viewing chemical compound data. It uses Flask for the backend and a self-contained SQLite database, making it highly portable and easy to set up.
- Miniconda or Anaconda must be installed. This is the recommended way to install the
rdkitdependency, especially on Windows.
Follow these steps to get the application running on a new machine.
Open your terminal or Anaconda Prompt and navigate to the project's root directory. Run the following command to create a new Conda environment using the provided file. This will install all required libraries.
conda env create -f environment.ymlBefore running any scripts, you must activate the new environment.
conda activate chemical-repoRun the following command from the project's root directory. This single command will:
- Create a new
database.dbfile. - Set up the necessary tables using
schema.sql. - Populate the database with a list of common chemical compounds.
python seed.pyFinally, start the Flask web server with this command:
python -m gui_app.app- Once the server is running, open your web browser and go to
http://127.0.0.1:5000. - You can now:
- View the list of pre-loaded compounds.
- Search for compounds by name, SMILES, or formula.
- Upload new compounds by providing their SMILES string.