CoolFace
Apppublic

testkeefe/my_Schema_Study

sourceHugging Facegpl-3.0updated 1y agoView on Hugging Face
0likes
README.md70 linesDownload Raw Back to root
1---2title: Schema Study - BILD 5 V2.03emoji: ๐Ÿ“š4colorFrom: green5colorTo: gray6sdk: streamlit7sdk_version: 1.45.08app_file: app.py9pinned: true10license: gpl-3.011short_description: AI-enhanced study app for UCSD BILD5 biology students12---13 14# Schema Study: An AI-Enhanced Study App for Biology Students15 16Schema Study is a modern, interactive study app designed to help biology students master core course concepts through AI-powered conversations. The app leverages OpenAI's GPT models to provide instant feedback, Socratic questioning, and personalized study support.17 18## Features19- **Password Protection:** Secure access for your class or group.20- **Customizable Terms:** Use your own CSV file of terms and definitions.21- **Prompt Templates:** Engage with the material using creative, research-based prompts.22- **AI-Enhanced Feedback:** Get instant, formative feedback and guidance.23- **Professional, Accessible UI:** Clean, modern design with a color palette for clarity and focus.24 25## How to Use (Students)261. **Access the App:** Go to your Hugging Face Space URL. Enter the password provided by your instructor.272. **Select a Term:** Use the dropdown to pick a course term.283. **Start Studying:** Respond to the prompt or use a template button to begin your session.294. **Chat with the AI:** Ask questions, answer prompts, and explore the term in depth.30 31## How to Use (Instructors)321. **Clone or Fork the Space:**33   ```bash34   git clone https://huggingface.co/spaces/<your-username>/<your-space-name>35   cd <your-space-name>36   ```372. **Edit Configuration:**38   - Update `config.py` for your course (title, instructions, prompt templates, etc).39   - Place your terms CSV (e.g., `all_terms.csv`) in the root directory. Format: first column = term, second column = context/definition.403. **Set Secrets:**41   - In your Space, go to **Settings > Repository secrets** and add:42     - `OPENAI_API_KEY` (your OpenAI API key)43     - `username` (for app login)44     - `password` (for app login)454. **Push Changes:**46   ```bash47   git add .48   git commit -m "Update configuration and terms"49   git push50   ```51 52## Configuration53- All settings are in `config.py` (title, instructions, prompt templates, resources, AI model parameters, etc).54- Theming is managed via `.streamlit/config.toml` and custom CSS in `app.py`.55- Dependencies are listed in `requirements.txt`.56 57## File Structure58- `app.py` โ€” Main Streamlit app59- `config.py` โ€” All app settings and customization60- `.streamlit/config.toml` โ€” Theme colors61- `requirements.txt` โ€” Python dependencies62- `all_terms.csv` โ€” Your course terms and definitions63- `BILD_5_Syllabus_Reuther_SP25.pdf` โ€” Example resource64 65## License66This project is licensed under the GNU GPL-3 License. See the [LICENSE](LICENSE) file for details.67 68## Acknowledgments69 70Developed by Keefe Reuther, Assistant Teaching Professor in the UC San Diego School of Biological Sciences. Special thanks to Dr. Liam O Mueller and the members of the Reuther Lab for their support and contributions.