CoolFace
Apppublic

testkeefe/my_Schema_Study

sourceHugging Facegpl-3.0updated 1y agoView on Hugging Face
0likes
App README

Schema Study: An AI-Enhanced Study App for Biology Students

Schema 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.

Features

  • —Password Protection: Secure access for your class or group.
  • —Customizable Terms: Use your own CSV file of terms and definitions.
  • —Prompt Templates: Engage with the material using creative, research-based prompts.
  • —AI-Enhanced Feedback: Get instant, formative feedback and guidance.
  • —Professional, Accessible UI: Clean, modern design with a color palette for clarity and focus.

How to Use (Students)

  1. 1.Access the App: Go to your Hugging Face Space URL. Enter the password provided by your instructor.
  2. 2.Select a Term: Use the dropdown to pick a course term.
  3. 3.Start Studying: Respond to the prompt or use a template button to begin your session.
  4. 4.Chat with the AI: Ask questions, answer prompts, and explore the term in depth.

How to Use (Instructors)

  1. 1.Clone or Fork the Space:
bash
   git clone https://huggingface.co/spaces/<your-username>/<your-space-name>
   cd <your-space-name>
  1. 1.Edit Configuration:
  2. 2.Update config.py for your course (title, instructions, prompt templates, etc).
  3. 3.Place your terms CSV (e.g., all_terms.csv) in the root directory. Format: first column = term, second column = context/definition.
  4. 4.Set Secrets:
  5. 5.In your Space, go to Settings > Repository secrets and add:
  6. 6.OPENAI_API_KEY (your OpenAI API key)
  7. 7.username (for app login)
  8. 8.password (for app login)
  9. 9.Push Changes:
bash
   git add .
   git commit -m "Update configuration and terms"
   git push

Configuration

  • —All settings are in config.py (title, instructions, prompt templates, resources, AI model parameters, etc).
  • —Theming is managed via .streamlit/config.toml and custom CSS in app.py.
  • —Dependencies are listed in requirements.txt.

File Structure

  • —app.py — Main Streamlit app
  • —config.py — All app settings and customization
  • —.streamlit/config.toml — Theme colors
  • —requirements.txt — Python dependencies
  • —all_terms.csv — Your course terms and definitions
  • —BILD_5_Syllabus_Reuther_SP25.pdf — Example resource

License

This project is licensed under the GNU GPL-3 License. See the LICENSE file for details.

Acknowledgments

Developed 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.