Skip to content

rohankishore/Schemix

Repository files navigation

banner Buy Me a Coffee at ko-fi.com

An IDE for Engineers, Scientists and Students made entirely with Python
Explore the docs »

Report Bug · Request Feature



📖 About The Project

Schemix is a modern, student-focused, Qt-based study companion designed for engineering and science learners. With support for rich note-taking, graph plotting, offline periodic table, unit conversion, scientific calculations, and markdown + LaTeX rendering, Schemix aims to be your all-in-one knowledge workstation.


image image image image

The main highlights of Schemix are:

  • Organized Boards: Create boards → subjects → chapters to manage notes and quizzes efficiently.
  • Rich Text Editor:
    • Supports headings, bullet lists, numbered points
    • Inline math expressions via MathJax
    • Insert images and icons for visual notes
  • Electric Circuit Analysis
  • SPC Analysis
  • Spring Analysis
  • Chemical Reaction Balancer
  • Graph Plotting: Plot mathematical equations on a real number range and insert the graph into the notes
  • Built-in offline periodic table
  • Wikipedia Summary Viewer: Search any topic and view its Wikipedia snippet inside the app.
  • Unit Converter: Convert units across categories like length, time, temperature, etc.
  • Scientific Calculator: Fully featured calculator with keyboard input support and dockable UI.

🏃 Getting Started

Let's set up Schemix on your PC!

Prerequisites

  • Windows 10 x64 or later, a Linux distro running kernel 6.x or later, or macOS High Sierra or later
    • You can use Windows 7 x64 or later if you're willing to build from source with PythonVista
  • Python 3.9 or later
  • Python installation is bootstrapped with pip
  • (Recommended) A fresh venv created with python3 -m venv venv (use python instead on Windows) and activated with venv\Scripts\activate
  • The contents of requirements.txt installed via pip install -r requirements.txt
  • (If building an installer) Inno Setup 6.4.3 or later

Installation

You can download a prebuilt installer from the Releases or build one yourself. If using prebuilt installers, just skip to the use section.

Building the installer

  1. Clone the repo or download a tarball
  2. Install all prerequisites
  3. python3 build.py to compile the program first (again, use python instead on Windows)
  4. Open up the .iss Inno Setup script and compile it via Ctrl+F9 or Build > Compile - installer can be found in Output folder
Using the installer

On Windows, just run the .exe file to install, duh. If Defender SmartScreen shows up saying the app is a virus, this is only because it's not signed. Just hit More info and then Run anyway. For Linux, just drag the folder out and run the main executable inside the folder to start the program. On macOS, you need to disable Gatekeeper if you haven't already with sudo spctl --master-disable. Afterwards, you can just unzip the app accordingly for your architecture and drag the Schemix.app bundle to your Applications folder.

Testing

This is for people who solely just want to run without installation for mostly testing purposes.

We need the prerequisites above. After getting them, you can run the program with pythonw main.py to run it without flooding your terminal with logging (Windows only), or you can just run with python3 main.py (again, use python on Windows) to troubleshoot errors and debug it.


🛣️ Roadmap

  • Plugin Architecture
  • AutoCAD support
  • Electric Circuit Analysis
  • SPC Analysis

and much much more...

🛂 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would improve this, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contributors

🪪 License

Distributed under the GPLv3 License. See LICENSE.txt for more information.

About

Schemix is a cross-platform Note taking software for Engineers and Scientific Users

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors